From b60c0f2d380f452ce2eac82fa30e93c1c81eebd3 Mon Sep 17 00:00:00 2001 From: Rhys Sullivan <39114868+RhysSullivan@users.noreply.github.com> Date: Wed, 7 Oct 2026 13:54:47 -0700 Subject: [PATCH 1/4] Regenerate the Google specs with per-operation scopes, and test them --- .../specs/google/google-admin-directory.json | 2 +- public/specs/google/google-admin-reports.json | 2 +- public/specs/google/google-apps-script.json | 2 +- public/specs/google/google-bigquery.json | 2 +- public/specs/google/google-calendar.json | 2 +- public/specs/google/google-chat.json | 2 +- public/specs/google/google-classroom.json | 2 +- .../google/google-cloud-resource-manager.json | 2 +- public/specs/google/google-docs.json | 2 +- public/specs/google/google-drive.json | 2 +- public/specs/google/google-forms.json | 2 +- public/specs/google/google-gmail.json | 2 +- public/specs/google/google-meet.json | 2 +- public/specs/google/google-people.json | 2 +- .../specs/google/google-photos-library.json | 2 +- .../specs/google/google-search-console.json | 2 +- public/specs/google/google-sheets.json | 2 +- public/specs/google/google-slides.json | 2 +- public/specs/google/google-tasks.json | 2 +- public/specs/google/google-youtube-data.json | 2 +- public/specs/google/manifest.json | 42 +++--- scripts/google-specs.test.ts | 128 +++++++++++++++++- 22 files changed, 168 insertions(+), 42 deletions(-) diff --git a/public/specs/google/google-admin-directory.json b/public/specs/google/google-admin-directory.json index 737654a1..81533975 100644 --- a/public/specs/google/google-admin-directory.json +++ b/public/specs/google/google-admin-directory.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Admin SDK API","version":"directory_v1","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."},"servers":[{"url":"https://admin.googleapis.com/"}],"paths":{"/admin/directory/v1/customer/{customerId}/devices/chromeos":{"get":{"operationId":"directory.chromeosdevices.list","x-executor-toolPath":"directory.chromeosdevices.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of Chrome OS devices within an account.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeChildOrgunits","in":"query","required":false,"description":"Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","schema":{"description":"Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Value should not exceed 300.","schema":{"description":"Maximum number of results to return. Value should not exceed 300.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Device property to use for sorting results.","schema":{"description":"Device property to use for sorting results.","enum":["annotatedLocation","annotatedUser","lastSync","notes","serialNumber","status"],"type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":false,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response.","schema":{"description":"The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","schema":{"description":"Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","schema":{"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevices"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu":{"post":{"operationId":"directory.chromeosdevices.moveDevicesToOu","x-executor-toolPath":"directory.chromeosdevices.moveDevicesToOu","tags":["Admin SDK API"],"description":"Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable. ID of the Google Workspace account","schema":{"description":"Immutable. ID of the Google Workspace account","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":true,"description":"Full path of the target organizational unit or its ID","schema":{"description":"Full path of the target organizational unit or its ID","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsMoveDevicesToOu"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}":{"get":{"operationId":"directory.chromeosdevices.get","x-executor-toolPath":"directory.chromeosdevices.get","tags":["Admin SDK API"],"description":"Retrieves a Chrome OS device's properties.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method.","schema":{"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]},"put":{"operationId":"directory.chromeosdevices.update","x-executor-toolPath":"directory.chromeosdevices.update","tags":["Admin SDK API"],"description":"Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","schema":{"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]},"patch":{"operationId":"directory.chromeosdevices.patch","x-executor-toolPath":"directory.chromeosdevices.patch","tags":["Admin SDK API"],"description":"Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","schema":{"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}":{"get":{"operationId":"admin.customer.devices.chromeos.commands.get","x-executor-toolPath":"admin.customer.devices.chromeos.commands.get","tags":["Admin SDK API"],"description":"Gets command data a specific command issued to the device.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable. ID of the Google Workspace account.","schema":{"description":"Immutable. ID of the Google Workspace account.","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Immutable. ID of Chrome OS Device.","schema":{"description":"Immutable. ID of Chrome OS Device.","type":"string"}},{"name":"commandId","in":"path","required":true,"description":"Immutable. ID of Chrome OS Device Command.","schema":{"description":"Immutable. ID of Chrome OS Device Command.","format":"int64","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesCommand"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand":{"post":{"operationId":"admin.customer.devices.chromeos.issueCommand","x-executor-toolPath":"admin.customer.devices.chromeos.issueCommand","tags":["Admin SDK API"],"description":"Issues a command for the device to execute.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable. ID of the Google Workspace account.","schema":{"description":"Immutable. ID of the Google Workspace account.","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Immutable. ID of Chrome OS Device.","schema":{"description":"Immutable. ID of Chrome OS Device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesIssueCommandRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesIssueCommandResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus":{"post":{"operationId":"admin.customer.devices.chromeos.batchChangeStatus","x-executor-toolPath":"admin.customer.devices.chromeos.batchChangeStatus","tags":["Admin SDK API"],"description":"Changes the status of a batch of ChromeOS devices. For more information about changing a ChromeOS device state [Repair, repurpose, or retire ChromeOS devices](https://support.google.com/chrome/a/answer/3523633).","parameters":[{"name":"customerId","in":"path","required":true,"description":"Required. Immutable ID of the Google Workspace account.","schema":{"description":"Required. Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchChangeChromeOsDeviceStatusRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchChangeChromeOsDeviceStatusResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices":{"get":{"operationId":"admin.customer.devices.chromeos.countChromeOsDevices","x-executor-toolPath":"admin.customer.devices.chromeos.countChromeOsDevices","tags":["Admin SDK API"],"description":"Counts ChromeOS devices matching the request.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Required. Immutable ID of the Google Workspace account.","schema":{"description":"Required. Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","schema":{"description":"Optional. Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","type":"string"},"style":"form","explode":false},{"name":"includeChildOrgunits","in":"query","required":false,"description":"Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","schema":{"description":"Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":false,"description":"Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CountChromeOsDevicesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/mobile":{"get":{"operationId":"directory.mobiledevices.list","x-executor-toolPath":"directory.mobiledevices.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Max allowed value is 100.","schema":{"description":"Maximum number of results to return. Max allowed value is 100.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Device property to use for sorting results.","schema":{"description":"Device property to use for sorting results.","enum":["deviceId","email","lastSync","model","name","os","status","type"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list","schema":{"description":"Token to specify next page in the list","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Restrict information returned to a set of selected fields.","schema":{"description":"Restrict information returned to a set of selected fields.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators","schema":{"description":"Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","schema":{"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MobileDevices"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}},"/admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}":{"get":{"operationId":"directory.mobiledevices.get","x-executor-toolPath":"directory.mobiledevices.get","tags":["Admin SDK API"],"description":"Retrieves a mobile device's properties.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"resourceId","in":"path","required":true,"description":"The unique ID the API service uses to identify the mobile device.","schema":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Restrict information returned to a set of selected fields.","schema":{"description":"Restrict information returned to a set of selected fields.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MobileDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile"]},"delete":{"operationId":"directory.mobiledevices.delete","x-executor-toolPath":"directory.mobiledevices.delete","tags":["Admin SDK API"],"description":"Removes a mobile device.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"resourceId","in":"path","required":true,"description":"The unique ID the API service uses to identify the mobile device.","schema":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}},"/admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action":{"post":{"operationId":"directory.mobiledevices.action","x-executor-toolPath":"directory.mobiledevices.action","tags":["Admin SDK API"],"description":"Takes an action that affects a mobile device. For example, remotely wiping a device.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"resourceId","in":"path","required":true,"description":"The unique ID the API service uses to identify the mobile device.","schema":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MobileDeviceAction"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}},"/admin/directory/v1/customer/{customerId}/orgunits":{"get":{"operationId":"directory.orgunits.list","x-executor-toolPath":"directory.orgunits.list","tags":["Admin SDK API"],"description":"Retrieves a list of all organizational units for an account.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":false,"description":"The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.","schema":{"description":"The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.","default":"","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"type","in":"query","required":false,"description":"Whether to return all sub-organizations or just immediate children.","schema":{"description":"Whether to return all sub-organizations or just immediate children.","enum":["all","children","allIncludingParent"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnits"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]},"post":{"operationId":"directory.orgunits.insert","x-executor-toolPath":"directory.orgunits.insert","tags":["Admin SDK API"],"description":"Adds an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]}},"/admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath}":{"get":{"operationId":"directory.orgunits.get","x-executor-toolPath":"directory.orgunits.get","tags":["Admin SDK API"],"description":"Retrieves an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]},"put":{"operationId":"directory.orgunits.update","x-executor-toolPath":"directory.orgunits.update","tags":["Admin SDK API"],"description":"Updates an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]},"delete":{"operationId":"directory.orgunits.delete","x-executor-toolPath":"directory.orgunits.delete","tags":["Admin SDK API"],"description":"Removes an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]},"patch":{"operationId":"directory.orgunits.patch","x-executor-toolPath":"directory.orgunits.patch","tags":["Admin SDK API"],"description":"Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]}},"/admin/directory/v1/customer/{customerId}/schemas":{"get":{"operationId":"directory.schemas.list","x-executor-toolPath":"directory.schemas.list","tags":["Admin SDK API"],"description":"Retrieves all schemas for a customer.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schemas"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]},"post":{"operationId":"directory.schemas.insert","x-executor-toolPath":"directory.schemas.insert","tags":["Admin SDK API"],"description":"Creates a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]}},"/admin/directory/v1/customer/{customerId}/schemas/{schemaKey}":{"get":{"operationId":"directory.schemas.get","x-executor-toolPath":"directory.schemas.get","tags":["Admin SDK API"],"description":"Retrieves a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]},"put":{"operationId":"directory.schemas.update","x-executor-toolPath":"directory.schemas.update","tags":["Admin SDK API"],"description":"Updates a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]},"delete":{"operationId":"directory.schemas.delete","x-executor-toolPath":"directory.schemas.delete","tags":["Admin SDK API"],"description":"Deletes a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]},"patch":{"operationId":"directory.schemas.patch","x-executor-toolPath":"directory.schemas.patch","tags":["Admin SDK API"],"description":"Patches a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]}},"/admin/directory/v1/customer/{customer}/domainaliases":{"get":{"operationId":"directory.domainAliases.list","x-executor-toolPath":"directory.domainAliases.list","tags":["Admin SDK API"],"description":"Lists the domain aliases of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parentDomainName","in":"query","required":false,"description":"Name of the parent domain for which domain aliases are to be fetched.","schema":{"description":"Name of the parent domain for which domain aliases are to be fetched.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAliases"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]},"post":{"operationId":"directory.domainAliases.insert","x-executor-toolPath":"directory.domainAliases.insert","tags":["Admin SDK API"],"description":"Inserts a domain alias of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}":{"get":{"operationId":"directory.domainAliases.get","x-executor-toolPath":"directory.domainAliases.get","tags":["Admin SDK API"],"description":"Retrieves a domain alias of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"domainAliasName","in":"path","required":true,"description":"Name of domain alias to be retrieved.","schema":{"description":"Name of domain alias to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]},"delete":{"operationId":"directory.domainAliases.delete","x-executor-toolPath":"directory.domainAliases.delete","tags":["Admin SDK API"],"description":"Deletes a domain Alias of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"domainAliasName","in":"path","required":true,"description":"Name of domain alias to be retrieved.","schema":{"description":"Name of domain alias to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/domains":{"get":{"operationId":"directory.domains.list","x-executor-toolPath":"directory.domains.list","tags":["Admin SDK API"],"description":"Lists the domains of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains2"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]},"post":{"operationId":"directory.domains.insert","x-executor-toolPath":"directory.domains.insert","tags":["Admin SDK API"],"description":"Inserts a domain of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/domains/{domainName}":{"get":{"operationId":"directory.domains.get","x-executor-toolPath":"directory.domains.get","tags":["Admin SDK API"],"description":"Retrieves a domain of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"domainName","in":"path","required":true,"description":"Name of domain to be retrieved","schema":{"description":"Name of domain to be retrieved","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]},"delete":{"operationId":"directory.domains.delete","x-executor-toolPath":"directory.domains.delete","tags":["Admin SDK API"],"description":"Deletes a domain of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"domainName","in":"path","required":true,"description":"Name of domain to be deleted","schema":{"description":"Name of domain to be deleted","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/resources/buildings":{"get":{"operationId":"directory.resources.buildings.list","x-executor-toolPath":"directory.resources.buildings.list","tags":["Admin SDK API"],"description":"Retrieves a list of buildings for an account.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Buildings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"post":{"operationId":"directory.resources.buildings.insert","x-executor-toolPath":"directory.resources.buildings.insert","tags":["Admin SDK API"],"description":"Inserts a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"coordinatesSource","in":"query","required":false,"description":"Source from which Building.coordinates are derived.","schema":{"description":"Source from which Building.coordinates are derived.","default":"SOURCE_UNSPECIFIED","enum":["CLIENT_SPECIFIED","RESOLVED_FROM_ADDRESS","SOURCE_UNSPECIFIED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}":{"get":{"operationId":"directory.resources.buildings.get","x-executor-toolPath":"directory.resources.buildings.get","tags":["Admin SDK API"],"description":"Retrieves a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The unique ID of the building to retrieve.","schema":{"description":"The unique ID of the building to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"put":{"operationId":"directory.resources.buildings.update","x-executor-toolPath":"directory.resources.buildings.update","tags":["Admin SDK API"],"description":"Updates a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The id of the building to update.","schema":{"description":"The id of the building to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"coordinatesSource","in":"query","required":false,"description":"Source from which Building.coordinates are derived.","schema":{"description":"Source from which Building.coordinates are derived.","default":"SOURCE_UNSPECIFIED","enum":["CLIENT_SPECIFIED","RESOLVED_FROM_ADDRESS","SOURCE_UNSPECIFIED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"delete":{"operationId":"directory.resources.buildings.delete","x-executor-toolPath":"directory.resources.buildings.delete","tags":["Admin SDK API"],"description":"Deletes a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The id of the building to delete.","schema":{"description":"The id of the building to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"patch":{"operationId":"directory.resources.buildings.patch","x-executor-toolPath":"directory.resources.buildings.patch","tags":["Admin SDK API"],"description":"Patches a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The id of the building to update.","schema":{"description":"The id of the building to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"coordinatesSource","in":"query","required":false,"description":"Source from which Building.coordinates are derived.","schema":{"description":"Source from which Building.coordinates are derived.","default":"SOURCE_UNSPECIFIED","enum":["CLIENT_SPECIFIED","RESOLVED_FROM_ADDRESS","SOURCE_UNSPECIFIED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/calendars":{"get":{"operationId":"directory.resources.calendars.list","x-executor-toolPath":"directory.resources.calendars.list","tags":["Admin SDK API"],"description":"Retrieves a list of calendar resources for an account.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form \"field [asc|desc], field [asc|desc], ...\". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order.","schema":{"description":"Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form \"field [asc|desc], field [asc|desc], ...\". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.","schema":{"description":"String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResources"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"post":{"operationId":"directory.resources.calendars.insert","x-executor-toolPath":"directory.resources.calendars.insert","tags":["Admin SDK API"],"description":"Inserts a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}":{"get":{"operationId":"directory.resources.calendars.get","x-executor-toolPath":"directory.resources.calendars.get","tags":["Admin SDK API"],"description":"Retrieves a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to retrieve.","schema":{"description":"The unique ID of the calendar resource to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"put":{"operationId":"directory.resources.calendars.update","x-executor-toolPath":"directory.resources.calendars.update","tags":["Admin SDK API"],"description":"Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to update.","schema":{"description":"The unique ID of the calendar resource to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"delete":{"operationId":"directory.resources.calendars.delete","x-executor-toolPath":"directory.resources.calendars.delete","tags":["Admin SDK API"],"description":"Deletes a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to delete.","schema":{"description":"The unique ID of the calendar resource to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"patch":{"operationId":"directory.resources.calendars.patch","x-executor-toolPath":"directory.resources.calendars.patch","tags":["Admin SDK API"],"description":"Patches a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to update.","schema":{"description":"The unique ID of the calendar resource to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/features":{"get":{"operationId":"directory.resources.features.list","x-executor-toolPath":"directory.resources.features.list","tags":["Admin SDK API"],"description":"Retrieves a list of features for an account.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Features"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"post":{"operationId":"directory.resources.features.insert","x-executor-toolPath":"directory.resources.features.insert","tags":["Admin SDK API"],"description":"Inserts a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/features/{featureKey}":{"get":{"operationId":"directory.resources.features.get","x-executor-toolPath":"directory.resources.features.get","tags":["Admin SDK API"],"description":"Retrieves a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to retrieve.","schema":{"description":"The unique ID of the feature to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"put":{"operationId":"directory.resources.features.update","x-executor-toolPath":"directory.resources.features.update","tags":["Admin SDK API"],"description":"Updates a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to update.","schema":{"description":"The unique ID of the feature to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"delete":{"operationId":"directory.resources.features.delete","x-executor-toolPath":"directory.resources.features.delete","tags":["Admin SDK API"],"description":"Deletes a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to delete.","schema":{"description":"The unique ID of the feature to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"patch":{"operationId":"directory.resources.features.patch","x-executor-toolPath":"directory.resources.features.patch","tags":["Admin SDK API"],"description":"Patches a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to update.","schema":{"description":"The unique ID of the feature to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename":{"post":{"operationId":"directory.resources.features.rename","x-executor-toolPath":"directory.resources.features.rename","tags":["Admin SDK API"],"description":"Renames a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"oldName","in":"path","required":true,"description":"The unique ID of the feature to rename.","schema":{"description":"The unique ID of the feature to rename.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_FeatureRename"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/roleassignments":{"get":{"operationId":"directory.roleAssignments.list","x-executor-toolPath":"directory.roleAssignments.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all roleAssignments.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeIndirectRoleAssignments","in":"query","required":false,"description":"When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `user_key` or the indirect role assignments will not be included.","schema":{"description":"When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `user_key` or the indirect role assignments will not be included.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"roleId","in":"query","required":false,"description":"Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.","schema":{"description":"Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userKey","in":"query","required":false,"description":"The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group.","schema":{"description":"The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignments"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"post":{"operationId":"directory.roleAssignments.insert","x-executor-toolPath":"directory.roleAssignments.insert","tags":["Admin SDK API"],"description":"Creates a role assignment.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}":{"get":{"operationId":"directory.roleAssignments.get","x-executor-toolPath":"directory.roleAssignments.get","tags":["Admin SDK API"],"description":"Retrieves a role assignment.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"roleAssignmentId","in":"path","required":true,"description":"Immutable ID of the role assignment.","schema":{"description":"Immutable ID of the role assignment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"delete":{"operationId":"directory.roleAssignments.delete","x-executor-toolPath":"directory.roleAssignments.delete","tags":["Admin SDK API"],"description":"Deletes a role assignment.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleAssignmentId","in":"path","required":true,"description":"Immutable ID of the role assignment.","schema":{"description":"Immutable ID of the role assignment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roles":{"get":{"operationId":"directory.roles.list","x-executor-toolPath":"directory.roles.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all the roles in a domain.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Roles"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"post":{"operationId":"directory.roles.insert","x-executor-toolPath":"directory.roles.insert","tags":["Admin SDK API"],"description":"Creates a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roles/ALL/privileges":{"get":{"operationId":"directory.privileges.list","x-executor-toolPath":"directory.privileges.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all privileges for a customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Privileges"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roles/{roleId}":{"get":{"operationId":"directory.roles.get","x-executor-toolPath":"directory.roles.get","tags":["Admin SDK API"],"description":"Retrieves a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"put":{"operationId":"directory.roles.update","x-executor-toolPath":"directory.roles.update","tags":["Admin SDK API"],"description":"Updates a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"delete":{"operationId":"directory.roles.delete","x-executor-toolPath":"directory.roles.delete","tags":["Admin SDK API"],"description":"Deletes a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"patch":{"operationId":"directory.roles.patch","x-executor-toolPath":"directory.roles.patch","tags":["Admin SDK API"],"description":"Patches a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customers/{customerKey}":{"get":{"operationId":"directory.customers.get","x-executor-toolPath":"directory.customers.get","tags":["Admin SDK API"],"description":"Retrieves a customer.","parameters":[{"name":"customerKey","in":"path","required":true,"description":"Id of the customer to be retrieved","schema":{"description":"Id of the customer to be retrieved","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.customer"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.customer"]},"put":{"operationId":"directory.customers.update","x-executor-toolPath":"directory.customers.update","tags":["Admin SDK API"],"description":"Updates a customer.","parameters":[{"name":"customerKey","in":"path","required":true,"description":"Id of the customer to be updated","schema":{"description":"Id of the customer to be updated","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.customer"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.customer"]},"patch":{"operationId":"directory.customers.patch","x-executor-toolPath":"directory.customers.patch","tags":["Admin SDK API"],"description":"Patches a customer.","parameters":[{"name":"customerKey","in":"path","required":true,"description":"Id of the customer to be updated","schema":{"description":"Id of the customer to be updated","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.customer"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.customer"]}},"/admin/directory/v1/customers/{customersId}/chrome/printServers/{printServersId}":{"get":{"operationId":"admin.customers.chrome.printServers.get","x-executor-toolPath":"admin.customers.chrome.printServers.get","tags":["Admin SDK API"],"description":"Returns a print server's configuration.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"printServersId","in":"path","required":true,"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"delete":{"operationId":"admin.customers.chrome.printServers.delete","x-executor-toolPath":"admin.customers.chrome.printServers.delete","tags":["Admin SDK API"],"description":"Deletes a print server.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"printServersId","in":"path","required":true,"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","schema":{"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"patch":{"operationId":"admin.customers.chrome.printServers.patch","x-executor-toolPath":"admin.customers.chrome.printServers.patch","tags":["Admin SDK API"],"description":"Updates a print server's configuration.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"printServersId","in":"path","required":true,"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","schema":{"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"The list of fields to update. Some fields are read-only and cannot be updated. Values for unspecified fields are patched.","schema":{"description":"The list of fields to update. Some fields are read-only and cannot be updated. Values for unspecified fields are patched.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/customers/{customersId}/chrome/printers/{printersId}":{"get":{"operationId":"admin.customers.chrome.printers.get","x-executor-toolPath":"admin.customers.chrome.printers.get","tags":["Admin SDK API"],"description":"Returns a `Printer` resource (printer's config).","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"printersId","in":"path","required":true,"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"delete":{"operationId":"admin.customers.chrome.printers.delete","x-executor-toolPath":"admin.customers.chrome.printers.delete","tags":["Admin SDK API"],"description":"Deletes a `Printer`.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"printersId","in":"path","required":true,"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"patch":{"operationId":"admin.customers.chrome.printers.patch","x-executor-toolPath":"admin.customers.chrome.printers.patch","tags":["Admin SDK API"],"description":"Updates a `Printer` resource.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","type":"string"},"allowReserved":true},{"name":"printersId","in":"path","required":true,"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","schema":{"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"clearMask","in":"query","required":false,"description":"The list of fields to be cleared. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","schema":{"description":"The list of fields to be cleared. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"The list of fields to be updated. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","schema":{"description":"The list of fields to be updated. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/groups":{"get":{"operationId":"directory.groups.list","x-executor-toolPath":"directory.groups.list","tags":["Admin SDK API"],"description":"Retrieves all groups of a domain or of a user given a userKey (paginated).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customer","in":"query","required":false,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"},"style":"form","explode":false},{"name":"domain","in":"query","required":false,"description":"The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.","schema":{"description":"The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Max allowed value is 200.","schema":{"description":"Maximum number of results to return. Max allowed value is 200.","format":"int32","default":200,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Column to use for sorting results","schema":{"description":"Column to use for sorting results","enum":["email"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list","schema":{"description":"Token to specify next page in the list","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups).","schema":{"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order. Only of use when orderBy is also used","schema":{"description":"Whether to return results in ascending or descending order. Only of use when orderBy is also used","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userKey","in":"query","required":false,"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. Cannot be used with the `customer` parameter.","schema":{"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. Cannot be used with the `customer` parameter.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Groups"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"post":{"operationId":"directory.groups.insert","x-executor-toolPath":"directory.groups.insert","tags":["Admin SDK API"],"description":"Creates a group.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}":{"get":{"operationId":"directory.groups.get","x-executor-toolPath":"directory.groups.get","tags":["Admin SDK API"],"description":"Retrieves a group's properties.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"put":{"operationId":"directory.groups.update","x-executor-toolPath":"directory.groups.update","tags":["Admin SDK API"],"description":"Updates a group's properties.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"delete":{"operationId":"directory.groups.delete","x-executor-toolPath":"directory.groups.delete","tags":["Admin SDK API"],"description":"Deletes a group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"patch":{"operationId":"directory.groups.patch","x-executor-toolPath":"directory.groups.patch","tags":["Admin SDK API"],"description":"Updates a group's properties. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/aliases":{"get":{"operationId":"directory.groups.aliases.list","x-executor-toolPath":"directory.groups.aliases.list","tags":["Admin SDK API"],"description":"Lists all aliases for a group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Aliases"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"post":{"operationId":"directory.groups.aliases.insert","x-executor-toolPath":"directory.groups.aliases.insert","tags":["Admin SDK API"],"description":"Adds an alias for the group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/aliases/{alias}":{"delete":{"operationId":"directory.groups.aliases.delete","x-executor-toolPath":"directory.groups.aliases.delete","tags":["Admin SDK API"],"description":"Removes an alias.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"alias","in":"path","required":true,"description":"The alias to be removed","schema":{"description":"The alias to be removed","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}":{"get":{"operationId":"directory.members.hasMember","x-executor-toolPath":"directory.members.hasMember","tags":["Admin SDK API"],"description":"Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group's domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.","schema":{"description":"Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MembersHasMember"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/members":{"get":{"operationId":"directory.members.list","x-executor-toolPath":"directory.members.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDerivedMembership","in":"query","required":false,"description":"Whether to list indirect memberships. Default: false.","schema":{"description":"Whether to list indirect memberships. Default: false.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Max allowed value is 200.","schema":{"description":"Maximum number of results to return. Max allowed value is 200.","format":"int32","default":200,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list.","schema":{"description":"Token to specify next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"roles","in":"query","required":false,"description":"The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.","schema":{"description":"The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Members"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"post":{"operationId":"directory.members.insert","x-executor-toolPath":"directory.members.insert","tags":["Admin SDK API"],"description":"Adds a user to the specified group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/members/{memberKey}":{"get":{"operationId":"directory.members.get","x-executor-toolPath":"directory.members.get","tags":["Admin SDK API"],"description":"Retrieves a group member's properties.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"put":{"operationId":"directory.members.update","x-executor-toolPath":"directory.members.update","tags":["Admin SDK API"],"description":"Updates the membership of a user in the specified group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"delete":{"operationId":"directory.members.delete","x-executor-toolPath":"directory.members.delete","tags":["Admin SDK API"],"description":"Removes a member from a group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"patch":{"operationId":"directory.members.patch","x-executor-toolPath":"directory.members.patch","tags":["Admin SDK API"],"description":"Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/users":{"get":{"operationId":"directory.users.list","x-executor-toolPath":"directory.users.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of either deleted users or all users in a domain.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customFieldMask","in":"query","required":false,"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","schema":{"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","type":"string"},"style":"form","explode":false},{"name":"customer","in":"query","required":false,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"},"style":"form","explode":false},{"name":"domain","in":"query","required":false,"description":"The domain name. Use this field to get users from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.","schema":{"description":"The domain name. Use this field to get users from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Event on which subscription is intended (if subscribing)","schema":{"description":"Event on which subscription is intended (if subscribing)","enum":["add","delete","makeAdmin","undelete","update"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Property to use for sorting results.","schema":{"description":"Property to use for sorting results.","enum":["email","familyName","givenName"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list. The page token is only valid for three days.","schema":{"description":"Token to specify next page in the list. The page token is only valid for three days.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"What subset of fields to fetch for this user.","schema":{"description":"What subset of fields to fetch for this user.","default":"basic","enum":["basic","custom","full"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","schema":{"description":"Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"If set to `true`, retrieves the list of deleted users. (Default: `false`)","schema":{"description":"If set to `true`, retrieves the list of deleted users. (Default: `false`)","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order, ignoring case.","schema":{"description":"Whether to return results in ascending or descending order, ignoring case.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"viewType","in":"query","required":false,"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","schema":{"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","default":"admin_view","enum":["admin_view","domain_public"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Users"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"post":{"operationId":"directory.users.insert","x-executor-toolPath":"directory.users.insert","tags":["Admin SDK API"],"description":"Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolve_conflict_account` is set to `true`, the option selected for [Find and add unmanaged users](https://knowledge.workspace.google.com/admin/users/find-and-add-unmanaged-users) will apply to resolve conflicting accounts: - A `200` response code indicates the user was created (or replaced an existing unmanaged personal account). - A `202` response code means that a conflicting unmanaged personal account exists and was invited to join the organization. - A `409` response code means that a conflicting account exists so the user wasn't created (e.g. based on the option selected to preserve the account, or if the email conflicts with an unmanaged work account or existing managed user). For details on resolving duplicate account errors, see [Resolve duplicate account errors](https://knowledge.workspace.google.com/p/duplicate-account-errors) and [Transfer unmanaged work accounts](https://knowledge.workspace.google.com/p/unmanaged-work-accounts).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"resolveConflictAccount","in":"query","required":false,"description":"Optional. Applies the option selected for [Find and add unmanaged users](https://knowledge.workspace.google.com/admin/users/find-and-add-unmanaged-users) to resolve conflicting accounts when set to `true`. Default: `false`","schema":{"description":"Optional. Applies the option selected for [Find and add unmanaged users](https://knowledge.workspace.google.com/admin/users/find-and-add-unmanaged-users) to resolve conflicting accounts when set to `true`. Default: `false`","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/watch":{"post":{"operationId":"directory.users.watch","x-executor-toolPath":"directory.users.watch","tags":["Admin SDK API"],"description":"Watches for changes in users list.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customFieldMask","in":"query","required":false,"description":"Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.","schema":{"description":"Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.","type":"string"},"style":"form","explode":false},{"name":"customer","in":"query","required":false,"description":"Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.","schema":{"description":"Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.","type":"string"},"style":"form","explode":false},{"name":"domain","in":"query","required":false,"description":"Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.\"","schema":{"description":"Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.\"","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Events to watch for.","schema":{"description":"Events to watch for.","enum":["add","delete","makeAdmin","undelete","update"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Column to use for sorting results","schema":{"description":"Column to use for sorting results","enum":["email","familyName","givenName"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list","schema":{"description":"Token to specify next page in the list","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"What subset of fields to fetch for this user.","schema":{"description":"What subset of fields to fetch for this user.","default":"basic","enum":["basic","custom","full"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","schema":{"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"If set to true, retrieves the list of deleted users. (Default: false)","schema":{"description":"If set to true, retrieves the list of deleted users. (Default: false)","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order.","schema":{"description":"Whether to return results in ascending or descending order.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"viewType","in":"query","required":false,"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","schema":{"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","default":"admin_view","enum":["admin_view","domain_public"],"type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}":{"get":{"operationId":"directory.users.get","x-executor-toolPath":"directory.users.get","tags":["Admin SDK API"],"description":"Retrieves a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customFieldMask","in":"query","required":false,"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","schema":{"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"What subset of fields to fetch for this user.","schema":{"description":"What subset of fields to fetch for this user.","default":"basic","enum":["basic","custom","full"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"viewType","in":"query","required":false,"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","schema":{"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","default":"admin_view","enum":["admin_view","domain_public"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"put":{"operationId":"directory.users.update","x-executor-toolPath":"directory.users.update","tags":["Admin SDK API"],"description":"Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"delete":{"operationId":"directory.users.delete","x-executor-toolPath":"directory.users.delete","tags":["Admin SDK API"],"description":"Deletes a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"patch":{"operationId":"directory.users.patch","x-executor-toolPath":"directory.users.patch","tags":["Admin SDK API"],"description":"Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/aliases":{"get":{"operationId":"directory.users.aliases.list","x-executor-toolPath":"directory.users.aliases.list","tags":["Admin SDK API"],"description":"Lists all aliases for a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Events to watch for.","schema":{"description":"Events to watch for.","enum":["add","delete"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Aliases"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"post":{"operationId":"directory.users.aliases.insert","x-executor-toolPath":"directory.users.aliases.insert","tags":["Admin SDK API"],"description":"Adds an alias.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/aliases/watch":{"post":{"operationId":"directory.users.aliases.watch","x-executor-toolPath":"directory.users.aliases.watch","tags":["Admin SDK API"],"description":"Watches for changes in users list.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Email or immutable ID of the user","schema":{"description":"Email or immutable ID of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Events to watch for.","schema":{"description":"Events to watch for.","enum":["add","delete"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/aliases/{alias}":{"delete":{"operationId":"directory.users.aliases.delete","x-executor-toolPath":"directory.users.aliases.delete","tags":["Admin SDK API"],"description":"Removes an alias.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"alias","in":"path","required":true,"description":"The alias to be removed.","schema":{"description":"The alias to be removed.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/asps":{"get":{"operationId":"directory.asps.list","x-executor-toolPath":"directory.asps.list","tags":["Admin SDK API"],"description":"Lists the ASPs issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Asps"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/asps/{codeId}":{"get":{"operationId":"directory.asps.get","x-executor-toolPath":"directory.asps.get","tags":["Admin SDK API"],"description":"Gets information about an ASP issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"codeId","in":"path","required":true,"description":"The unique ID of the ASP.","schema":{"description":"The unique ID of the ASP.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Asp"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]},"delete":{"operationId":"directory.asps.delete","x-executor-toolPath":"directory.asps.delete","tags":["Admin SDK API"],"description":"Deletes an ASP issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"codeId","in":"path","required":true,"description":"The unique ID of the ASP to be deleted.","schema":{"description":"The unique ID of the ASP to be deleted.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/makeAdmin":{"post":{"operationId":"directory.users.makeAdmin","x-executor-toolPath":"directory.users.makeAdmin","tags":["Admin SDK API"],"description":"Makes a user a super administrator.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserMakeAdmin"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/photos/thumbnail":{"get":{"operationId":"directory.users.photos.get","x-executor-toolPath":"directory.users.photos.get","tags":["Admin SDK API"],"description":"Retrieves the user's photo.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"put":{"operationId":"directory.users.photos.update","x-executor-toolPath":"directory.users.photos.update","tags":["Admin SDK API"],"description":"Adds a photo for the user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"delete":{"operationId":"directory.users.photos.delete","x-executor-toolPath":"directory.users.photos.delete","tags":["Admin SDK API"],"description":"Removes the user's photo.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"patch":{"operationId":"directory.users.photos.patch","x-executor-toolPath":"directory.users.photos.patch","tags":["Admin SDK API"],"description":"Adds a photo for the user. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/signOut":{"post":{"operationId":"directory.users.signOut","x-executor-toolPath":"directory.users.signOut","tags":["Admin SDK API"],"description":"Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/tokens":{"get":{"operationId":"directory.tokens.list","x-executor-toolPath":"directory.tokens.list","tags":["Admin SDK API"],"description":"Returns the set of tokens specified user has issued to 3rd party applications.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Tokens"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/tokens/{clientId}":{"get":{"operationId":"directory.tokens.get","x-executor-toolPath":"directory.tokens.get","tags":["Admin SDK API"],"description":"Gets information about an access token issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"clientId","in":"path","required":true,"description":"The Client ID of the application the token is issued to.","schema":{"description":"The Client ID of the application the token is issued to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Token"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]},"delete":{"operationId":"directory.tokens.delete","x-executor-toolPath":"directory.tokens.delete","tags":["Admin SDK API"],"description":"Deletes all access tokens issued by a user for an application.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"clientId","in":"path","required":true,"description":"The Client ID of the application the token is issued to.","schema":{"description":"The Client ID of the application the token is issued to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/twoStepVerification/turnOff":{"post":{"operationId":"directory.twoStepVerification.turnOff","x-executor-toolPath":"directory.twoStepVerification.turnOff","tags":["Admin SDK API"],"description":"Turns off 2-Step Verification for user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/undelete":{"post":{"operationId":"directory.users.undelete","x-executor-toolPath":"directory.users.undelete","tags":["Admin SDK API"],"description":"Undeletes a deleted user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"The immutable id of the user","schema":{"description":"The immutable id of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserUndelete"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/verificationCodes":{"get":{"operationId":"directory.verificationCodes.list","x-executor-toolPath":"directory.verificationCodes.list","tags":["Admin SDK API"],"description":"Returns the current set of valid backup verification codes for the specified user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_VerificationCodes"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/verificationCodes/generate":{"post":{"operationId":"directory.verificationCodes.generate","x-executor-toolPath":"directory.verificationCodes.generate","tags":["Admin SDK API"],"description":"Generates new backup verification codes for the user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Email or immutable ID of the user","schema":{"description":"Email or immutable ID of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/verificationCodes/invalidate":{"post":{"operationId":"directory.verificationCodes.invalidate","x-executor-toolPath":"directory.verificationCodes.invalidate","tags":["Admin SDK API"],"description":"Invalidates the current backup verification codes for the user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Email or immutable ID of the user","schema":{"description":"Email or immutable ID of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users:createGuest":{"post":{"operationId":"directory.users.createGuest","x-executor-toolPath":"directory.users.createGuest","tags":["Admin SDK API"],"description":"Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Open Beta.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryUsersCreateGuestRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/{parent}/chrome/printServers":{"get":{"operationId":"admin.customers.chrome.printServers.list","x-executor-toolPath":"admin.customers.chrome.printServers.list","tags":["Admin SDK API"],"description":"Lists print server configurations.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`.","schema":{"description":"Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending \"desc\" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order.","schema":{"description":"Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending \"desc\" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order.","type":"string"},"style":"form","explode":false},{"name":"orgUnitId","in":"query","required":false,"description":"If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against.","schema":{"description":"If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of objects to return (default `100`, max `100`). The service might return fewer than this value.","schema":{"description":"The maximum number of objects to return (default `100`, max `100`). The service might return fewer than this value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A generated token to paginate results (the `next_page_token` from a previous call).","schema":{"description":"A generated token to paginate results (the `next_page_token` from a previous call).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ListPrintServersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"post":{"operationId":"admin.customers.chrome.printServers.create","x-executor-toolPath":"admin.customers.chrome.printServers.create","tags":["Admin SDK API"],"description":"Creates a print server.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printServers:batchCreatePrintServers":{"post":{"operationId":"admin.customers.chrome.printServers.batchCreatePrintServers","x-executor-toolPath":"admin.customers.chrome.printServers.batchCreatePrintServers","tags":["Admin SDK API"],"description":"Creates multiple print servers.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintServersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintServersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printServers:batchDeletePrintServers":{"post":{"operationId":"admin.customers.chrome.printServers.batchDeletePrintServers","x-executor-toolPath":"admin.customers.chrome.printServers.batchDeletePrintServers","tags":["Admin SDK API"],"description":"Deletes multiple print servers.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintServersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintServersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers":{"get":{"operationId":"admin.customers.chrome.printers.list","x-executor-toolPath":"admin.customers.chrome.printers.list","tags":["Admin SDK API"],"description":"List printers configs.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Search query. Search syntax is shared between this api and Admin Console printers pages.","schema":{"description":"Search query. Search syntax is shared between this api and Admin Console printers pages.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"The order to sort results by. Must be one of display_name, description, make_and_model, or create_time. Default order is ascending, but descending order can be returned by appending \"desc\" to the order_by field. For instance, \"description desc\" will return the printers sorted by description in descending order.","schema":{"description":"The order to sort results by. Must be one of display_name, description, make_and_model, or create_time. Default order is ascending, but descending order can be returned by appending \"desc\" to the order_by field. For instance, \"description desc\" will return the printers sorted by description in descending order.","type":"string"},"style":"form","explode":false},{"name":"orgUnitId","in":"query","required":false,"description":"Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id.","schema":{"description":"Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of objects to return. The service may return fewer than this value.","schema":{"description":"The maximum number of objects to return. The service may return fewer than this value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A page token, received from a previous call.","schema":{"description":"A page token, received from a previous call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ListPrintersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"post":{"operationId":"admin.customers.chrome.printers.create","x-executor-toolPath":"admin.customers.chrome.printers.create","tags":["Admin SDK API"],"description":"Creates a printer under given Organization Unit.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers:batchCreatePrinters":{"post":{"operationId":"admin.customers.chrome.printers.batchCreatePrinters","x-executor-toolPath":"admin.customers.chrome.printers.batchCreatePrinters","tags":["Admin SDK API"],"description":"Creates printers under given Organization Unit.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers:batchDeletePrinters":{"post":{"operationId":"admin.customers.chrome.printers.batchDeletePrinters","x-executor-toolPath":"admin.customers.chrome.printers.batchDeletePrinters","tags":["Admin SDK API"],"description":"Deletes printers in batch.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers:listPrinterModels":{"get":{"operationId":"admin.customers.chrome.printers.listPrinterModels","x-executor-toolPath":"admin.customers.chrome.printers.listPrinterModels","tags":["Admin SDK API"],"description":"Lists the supported printer models.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Filer to list only models by a given manufacturer in format: \"manufacturer:Brother\". Search syntax is shared between this api and Admin Console printers pages.","schema":{"description":"Filer to list only models by a given manufacturer in format: \"manufacturer:Brother\". Search syntax is shared between this api and Admin Console printers pages.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of objects to return. The service may return fewer than this value.","schema":{"description":"The maximum number of objects to return. The service may return fewer than this value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A page token, received from a previous call.","schema":{"description":"A page token, received from a previous call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ListPrinterModelsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory_v1/channels/stop":{"post":{"operationId":"admin.channels.stop","x-executor-toolPath":"admin.channels.stop","tags":["Admin SDK API"],"description":"Stops watching resources through this channel.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}}},"components":{"schemas":{"admin_directory_v1_Alias":{"description":"JSON template for Alias object in Directory API.","type":"object","properties":{"alias":{"type":"string"},"etag":{"type":"string"},"id":{"type":"string"},"kind":{"default":"admin#directory#alias","type":"string"},"primaryEmail":{"type":"string"}}},"admin_directory_v1_Aliases":{"description":"JSON response template to list aliases in Directory API.","type":"object","properties":{"aliases":{"type":"array","items":{}},"etag":{"type":"string"},"kind":{"default":"admin#directory#aliases","type":"string"}}},"admin_directory_v1_Asp":{"description":"An application-specific password (ASP) is used with applications that do not accept a verification code when logging into the application on certain devices. The ASP access code is used instead of the login and password you commonly use when accessing an application through a browser. For more information about ASPs and how to create one, see the [help center](https://support.google.com/a/answer/2537800#asp).","type":"object","properties":{"codeId":{"description":"The unique ID of the ASP.","format":"int32","type":"integer"},"creationTime":{"description":"The time when the ASP was created. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format.","format":"int64","type":"string"},"etag":{"description":"ETag of the ASP.","type":"string"},"kind":{"description":"The type of the API resource. This is always `admin#directory#asp`.","default":"admin#directory#asp","type":"string"},"lastTimeUsed":{"description":"The time when the ASP was last used. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format.","format":"int64","type":"string"},"name":{"description":"The name of the application that the user, represented by their `userId`, entered when the ASP was created.","type":"string"},"userKey":{"description":"The unique ID of the user who issued the ASP.","type":"string"}}},"admin_directory_v1_Asps":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of ASP resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Asp"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#aspList`.","default":"admin#directory#aspList","type":"string"}}},"admin_directory_v1_AuxiliaryMessage":{"description":"Auxiliary message about issues with printers or settings. Example: {message_type:AUXILIARY_MESSAGE_WARNING, field_mask:make_and_model, message:\"Given printer is invalid or no longer supported.\"}","type":"object","properties":{"auxiliaryMessage":{"description":"Human readable message in English. Example: \"Given printer is invalid or no longer supported.\"","type":"string"},"fieldMask":{"description":"Field that this message concerns.","format":"google-fieldmask","type":"string"},"severity":{"description":"Message severity","enum":["SEVERITY_UNSPECIFIED","SEVERITY_INFO","SEVERITY_WARNING","SEVERITY_ERROR"],"type":"string"}}},"admin_directory_v1_BacklightInfo":{"description":"Information about the device's backlights.","type":"object","properties":{"brightness":{"description":"Output only. Current brightness of the backlight, between 0 and max_brightness.","format":"int32","readOnly":true,"type":"integer"},"maxBrightness":{"description":"Output only. Maximum brightness for the backlight.","format":"int32","readOnly":true,"type":"integer"},"path":{"description":"Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.","readOnly":true,"type":"string"}}},"admin_directory_v1_BatchChangeChromeOsDeviceStatusRequest":{"description":"A request for changing the status of a batch of ChromeOS devices.","type":"object","properties":{"changeChromeOsDeviceStatusAction":{"description":"Required. The action to take on the ChromeOS device in order to change its status.","enum":["CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED","CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION","CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE","CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE"],"type":"string"},"deprovisionReason":{"description":"Optional. The reason behind a device deprovision. Must be provided if 'changeChromeOsDeviceStatusAction' is set to 'CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION'. Otherwise, omit this field.","enum":["DEPROVISION_REASON_UNSPECIFIED","DEPROVISION_REASON_SAME_MODEL_REPLACEMENT","DEPROVISION_REASON_UPGRADE","DEPROVISION_REASON_DOMAIN_MOVE","DEPROVISION_REASON_SERVICE_EXPIRATION","DEPROVISION_REASON_OTHER","DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT","DEPROVISION_REASON_RETIRING_DEVICE","DEPROVISION_REASON_UPGRADE_TRANSFER","DEPROVISION_REASON_NOT_REQUIRED","DEPROVISION_REASON_REPAIR_CENTER"],"type":"string"},"deviceIds":{"description":"Required. List of the IDs of the ChromeOS devices to change. Maximum 50.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchChangeChromeOsDeviceStatusResponse":{"description":"The response of changing the status of a batch of ChromeOS devices.","type":"object","properties":{"changeChromeOsDeviceStatusResults":{"description":"The results for each of the ChromeOS devices provided in the request.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_ChangeChromeOsDeviceStatusResult"}}}},"admin_directory_v1_BatchCreatePrintServersRequest":{"description":"Request to add multiple new print servers in a batch.","type":"object","properties":{"requests":{"description":"Required. A list of `PrintServer` resources to be created (max `50` per batch).","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_CreatePrintServerRequest"}}}},"admin_directory_v1_BatchCreatePrintServersResponse":{"type":"object","properties":{"failures":{"description":"A list of create failures. `PrintServer` IDs are not populated, as print servers were not created.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServerFailureInfo"}},"printServers":{"description":"A list of successfully created print servers with their IDs populated.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"admin_directory_v1_BatchCreatePrintersRequest":{"description":"Request for adding new printers in batch.","type":"object","properties":{"requests":{"description":"A list of Printers to be created. Max 50 at a time.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_CreatePrinterRequest"}}}},"admin_directory_v1_BatchCreatePrintersResponse":{"description":"Response for adding new printers in batch.","type":"object","properties":{"failures":{"description":"A list of create failures. Printer IDs are not populated, as printer were not created.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_FailureInfo"}},"printers":{"description":"A list of successfully created printers with their IDs populated.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"admin_directory_v1_BatchDeletePrintServersRequest":{"description":"Request to delete multiple existing print servers in a batch.","type":"object","properties":{"printServerIds":{"description":"A list of print server IDs that should be deleted (max `100` per batch).","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchDeletePrintServersResponse":{"type":"object","properties":{"failedPrintServers":{"description":"A list of update failures.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServerFailureInfo"}},"printServerIds":{"description":"A list of print server IDs that were successfully deleted.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchDeletePrintersRequest":{"description":"Request for deleting existing printers in batch.","type":"object","properties":{"printerIds":{"description":"A list of Printer.id that should be deleted. Max 100 at a time.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchDeletePrintersResponse":{"description":"Response for deleting existing printers in batch.","type":"object","properties":{"failedPrinters":{"description":"A list of update failures.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_FailureInfo"}},"printerIds":{"description":"A list of Printer.id that were successfully deleted.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BluetoothAdapterInfo":{"description":"Information about a device's Bluetooth adapter.","type":"object","properties":{"address":{"description":"Output only. The MAC address of the adapter.","readOnly":true,"type":"string"},"numConnectedDevices":{"description":"Output only. The number of devices connected to this adapter.","format":"int32","readOnly":true,"type":"integer"}}},"admin_directory_v1_Building":{"description":"Public API: Resources.buildings","type":"object","properties":{"address":{"$ref":"#/components/schemas/admin_directory_v1_BuildingAddress"},"buildingId":{"description":"Unique identifier for the building. The maximum length is 100 characters.","type":"string"},"buildingName":{"description":"The building name as seen by users in Calendar. Must be unique for the customer. For example, \"NYC-CHEL\". The maximum length is 100 characters.","type":"string"},"coordinates":{"$ref":"#/components/schemas/admin_directory_v1_BuildingCoordinates"},"description":{"description":"A brief description of the building. For example, \"Chelsea Market\".","type":"string"},"etags":{"description":"ETag of the resource.","type":"string"},"floorNames":{"description":"The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, [\"B2\", \"B1\", \"L\", \"1\", \"2\", \"2M\", \"3\", \"PH\"] Must contain at least one entry.","type":"array","items":{"type":"string"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#buildings#Building","type":"string"}}},"admin_directory_v1_BuildingAddress":{"description":"Public API: Resources.buildings","type":"object","properties":{"addressLines":{"description":"Unstructured address lines describing the lower levels of an address.","type":"array","items":{"type":"string"}},"administrativeArea":{"description":"Optional. Highest administrative subdivision which is used for postal addresses of a country or region.","type":"string"},"languageCode":{"description":"Optional. BCP-47 language code of the contents of this address (if known).","type":"string"},"locality":{"description":"Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.","type":"string"},"postalCode":{"description":"Optional. Postal code of the address.","type":"string"},"regionCode":{"description":"Required. CLDR region code of the country/region of the address.","type":"string"},"sublocality":{"description":"Optional. Sublocality of the address.","type":"string"}}},"admin_directory_v1_BuildingCoordinates":{"description":"Public API: Resources.buildings","type":"object","properties":{"latitude":{"description":"Latitude in decimal degrees.","format":"double","type":"number"},"longitude":{"description":"Longitude in decimal degrees.","format":"double","type":"number"}}},"admin_directory_v1_Buildings":{"description":"Public API: Resources.buildings","type":"object","properties":{"buildings":{"description":"The Buildings in this page of results.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Building"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#buildings#buildingsList","type":"string"},"nextPageToken":{"description":"The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.","type":"string"}}},"admin_directory_v1_ByteUsage":{"description":"Represents a data capacity with some amount of current usage in bytes.","type":"object","properties":{"capacityBytes":{"description":"Output only. The total capacity value, in bytes.","format":"int64","readOnly":true,"type":"string"},"usedBytes":{"description":"Output only. The current usage value, in bytes.","format":"int64","readOnly":true,"type":"string"}}},"admin_directory_v1_CalendarResource":{"description":"Public API: Resources.calendars","type":"object","properties":{"buildingId":{"description":"Unique ID for the building a resource is located in.","type":"string"},"capacity":{"description":"Capacity of a resource, number of seats in a room.","format":"int32","type":"integer"},"etags":{"description":"ETag of the resource.","type":"string"},"featureInstances":{"description":"Instances of features for the calendar resource."},"floorName":{"description":"Name of the floor a resource is located on.","type":"string"},"floorSection":{"description":"Name of the section within a floor a resource is located in.","type":"string"},"generatedResourceName":{"description":"The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, \"NYC-2-Training Room 1A (16)\".","type":"string"},"kind":{"description":"The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`.","default":"admin#directory#resources#calendars#CalendarResource","type":"string"},"resourceCategory":{"description":"The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.","type":"string"},"resourceDescription":{"description":"Description of the resource, visible only to admins.","type":"string"},"resourceEmail":{"description":"The read-only email for the calendar resource. Generated as part of creating a new calendar resource.","type":"string"},"resourceId":{"description":"The unique ID for the calendar resource.","type":"string"},"resourceName":{"description":"The name of the calendar resource. For example, \"Training Room 1A\".","type":"string"},"resourceType":{"description":"The type of the calendar resource, intended for non-room resources.","type":"string"},"userVisibleDescription":{"description":"Description of the resource, visible to users and admins.","type":"string"}}},"admin_directory_v1_CalendarResources":{"description":"Public API: Resources.calendars","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"The CalendarResources in this page of results.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}},"kind":{"description":"Identifies this as a collection of CalendarResources. This is always `admin#directory#resources#calendars#calendarResourcesList`.","default":"admin#directory#resources#calendars#calendarResourcesList","type":"string"},"nextPageToken":{"description":"The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.","type":"string"}}},"admin_directory_v1_ChangeChromeOsDeviceStatusResult":{"description":"The result of a single ChromeOS device for a Change state operation.","type":"object","properties":{"deviceId":{"description":"The unique ID of the ChromeOS device.","type":"string"},"error":{"$ref":"#/components/schemas/admin_directory_v1_Status"},"response":{"$ref":"#/components/schemas/admin_directory_v1_ChangeChromeOsDeviceStatusSucceeded"}}},"admin_directory_v1_ChangeChromeOsDeviceStatusSucceeded":{"description":"Response for a successful ChromeOS device status change.","type":"object"},"admin_directory_v1_Channel":{"description":"An notification channel used to watch for resource changes.","type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional. For example, `params.ttl` specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days.","type":"object","additionalProperties":{"type":"string"}},"payload":{"description":"A Boolean value to indicate whether payload is wanted. Optional.","type":"boolean"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel.","type":"string"}}},"admin_directory_v1_ChromeOsDevice":{"description":"Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices).","type":"object","properties":{"activeTimeRanges":{"description":"A list of active time ranges (Read-only).","type":"array","items":{"type":"object","properties":{"activeTime":{"description":"Duration of usage in milliseconds.","format":"int32","type":"integer"},"date":{"description":"Date of usage","format":"date","type":"string"}}}},"annotatedAssetId":{"description":"The asset identifier as noted by an administrator or specified during enrollment.","type":"string"},"annotatedLocation":{"description":"The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.","type":"string"},"annotatedUser":{"description":"The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.","type":"string"},"autoUpdateExpiration":{"description":"(Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use \"autoUpdateThrough\" instead.","format":"int64","type":"string"},"autoUpdateThrough":{"description":"Output only. The timestamp after which the device will stop receiving Chrome updates or support.","readOnly":true,"type":"string"},"backlightInfo":{"description":"Output only. Contains backlight information for the device.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_BacklightInfo"}},"bluetoothAdapterInfo":{"description":"Output only. Information about Bluetooth adapters of the device.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_BluetoothAdapterInfo"}},"bootMode":{"description":"The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).","type":"string"},"chromeOsType":{"description":"Output only. Chrome OS type of the device.","readOnly":true,"enum":["chromeOsTypeUnspecified","chromeOsFlex","chromeOs"],"type":"string"},"cpuInfo":{"description":"Information regarding CPU specs in the device.","type":"array","items":{"description":"CPU specs for a CPU.","type":"object","properties":{"architecture":{"description":"The CPU architecture.","type":"string"},"logicalCpus":{"description":"Information for the Logical CPUs","type":"array","items":{"description":"Status of a single logical CPU.","type":"object","properties":{"cStates":{"description":"C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.","type":"array","items":{"description":"Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.","type":"object","properties":{"displayName":{"description":"Name of the state.","type":"string"},"sessionDuration":{"description":"Time spent in the state since the last reboot.","format":"google-duration","type":"string"}}}},"currentScalingFrequencyKhz":{"description":"Current frequency the CPU is running at.","format":"int32","type":"integer"},"idleDuration":{"description":"Idle time since last boot.","format":"google-duration","type":"string"},"maxScalingFrequencyKhz":{"description":"Maximum frequency the CPU is allowed to run at, by policy.","format":"int32","type":"integer"}}}},"maxClockSpeedKhz":{"description":"The max CPU clock speed in kHz.","format":"int32","type":"integer"},"model":{"description":"The CPU model name.","type":"string"}}}},"cpuStatusReports":{"description":"Reports of CPU utilization and temperature (Read-only)","type":"array","items":{"type":"object","properties":{"cpuTemperatureInfo":{"description":"A list of CPU temperature samples.","type":"array","items":{"type":"object","properties":{"label":{"description":"CPU label","type":"string"},"temperature":{"description":"Temperature in Celsius degrees.","format":"int32","type":"integer"}}}},"cpuUtilizationPercentageInfo":{"type":"array","items":{"format":"int32","type":"integer"}},"reportTime":{"description":"Date and time the report was received.","format":"date-time","type":"string"}}}},"deprovisionReason":{"description":"(Read-only) Deprovision reason.","enum":["DEPROVISION_REASON_UNSPECIFIED","DEPROVISION_REASON_SAME_MODEL_REPLACEMENT","DEPROVISION_REASON_UPGRADE","DEPROVISION_REASON_DOMAIN_MOVE","DEPROVISION_REASON_SERVICE_EXPIRATION","DEPROVISION_REASON_OTHER","DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT","DEPROVISION_REASON_RETIRING_DEVICE","DEPROVISION_REASON_UPGRADE_TRANSFER","DEPROVISION_REASON_NOT_REQUIRED","DEPROVISION_REASON_REPAIR_CENTER"],"type":"string"},"deviceFiles":{"description":"A list of device files to download (Read-only)","type":"array","items":{"type":"object","properties":{"createTime":{"description":"Date and time the file was created","format":"date-time","type":"string"},"downloadUrl":{"description":"File download URL","type":"string"},"name":{"description":"File name","type":"string"},"type":{"description":"File type","type":"string"}}}},"deviceId":{"description":"The unique ID of the Chrome device.","type":"string"},"deviceLicenseType":{"description":"Output only. Device license type.","readOnly":true,"enum":["deviceLicenseTypeUnspecified","enterprise","enterpriseUpgrade","educationUpgrade","education","kioskUpgrade","enterpriseUpgradePerpetual","enterpriseUpgradeFixedTerm","educationUpgradePerpetual","educationUpgradeFixedTerm"],"type":"string"},"diskSpaceUsage":{"$ref":"#/components/schemas/admin_directory_v1_ByteUsage"},"diskVolumeReports":{"description":"Reports of disk space and other info about mounted/connected volumes.","type":"array","items":{"type":"object","properties":{"volumeInfo":{"description":"Disk volumes","type":"array","items":{"type":"object","properties":{"storageFree":{"description":"Free disk space [in bytes]","format":"int64","type":"string"},"storageTotal":{"description":"Total disk space [in bytes]","format":"int64","type":"string"},"volumeId":{"description":"Volume id","type":"string"}}}}}}},"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. 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 some devices.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"ethernetMacAddress":{"description":"The device's MAC address on the ethernet network interface.","type":"string"},"ethernetMacAddress0":{"description":"(Read-only) MAC address used by the Chromebook’s 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"},"extendedSupportEligible":{"description":"Output only. Whether or not the device requires the extended support opt in.","readOnly":true,"type":"boolean"},"extendedSupportEnabled":{"description":"Output only. Whether extended support policy is enabled on the device.","readOnly":true,"type":"boolean"},"extendedSupportStart":{"description":"Output only. Date of the device when extended support policy for automatic updates starts.","readOnly":true,"type":"string"},"fanInfo":{"description":"Output only. Fan information for the device.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_FanInfo"}},"firmwareVersion":{"description":"The Chrome device's firmware version.","type":"string"},"firstEnrollmentTime":{"description":"Date and time for the first time the device was enrolled.","type":"string"},"kind":{"description":"The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.","default":"admin#directory#chromeosdevice","type":"string"},"lastDeprovisionTimestamp":{"description":"(Read-only) Date and time for the last deprovision of the device.","type":"string"},"lastEnrollmentTime":{"description":"Date and time the device was last enrolled (Read-only)","format":"date-time","type":"string"},"lastKnownNetwork":{"description":"Contains last known network (Read-only)","type":"array","items":{"description":"Information for an ip address.","type":"object","properties":{"ipAddress":{"description":"The IP address.","type":"string"},"wanIpAddress":{"description":"The WAN IP address.","type":"string"}}}},"lastSync":{"description":"Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)","format":"date-time","type":"string"},"macAddress":{"description":"The device's wireless MAC address. If the device does not have this information, it is not included in the response.","type":"string"},"manufactureDate":{"description":"(Read-only) The date the device was manufactured in yyyy-mm-dd format.","type":"string"},"meid":{"description":"The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid).","type":"string"},"model":{"description":"The device's model information. If the device does not have this information, this property is not included in the response.","type":"string"},"notes":{"description":"Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.","type":"string"},"orderNumber":{"description":"The device's order number. Only devices directly purchased from Google have an order number.","type":"string"},"orgUnitId":{"description":"The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).","type":"string"},"orgUnitPath":{"description":"The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).","type":"string"},"osUpdateStatus":{"$ref":"#/components/schemas/admin_directory_v1_OsUpdateStatus"},"osVersion":{"description":"The Chrome device's operating system version.","type":"string"},"osVersionCompliance":{"description":"Output only. Device policy compliance status of the OS version.","readOnly":true,"enum":["complianceUnspecified","compliant","pending","notCompliant"],"type":"string"},"platformVersion":{"description":"The Chrome device's platform version.","type":"string"},"recentUsers":{"description":"A list of recent device users, in descending order, by last login time.","type":"array","items":{"description":"A list of recent device users, in descending order, by last login time.","type":"object","properties":{"email":{"description":"The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.","type":"string"},"type":{"description":"The type of the user.","type":"string"}}}},"screenshotFiles":{"description":"A list of screenshot files to download. Type is always \"SCREENSHOT_FILE\". (Read-only)","type":"array","items":{"type":"object","properties":{"createTime":{"description":"Date and time the file was created","format":"date-time","type":"string"},"downloadUrl":{"description":"File download URL","type":"string"},"name":{"description":"File name","type":"string"},"type":{"description":"File type","type":"string"}}}},"serialNumber":{"description":"The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.","type":"string"},"status":{"description":"The status of the device.","type":"string"},"supportEndDate":{"description":"Final date the device will be supported (Read-only)","format":"date-time","type":"string"},"systemRamFreeReports":{"description":"Reports of amounts of available RAM memory (Read-only)","type":"array","items":{"type":"object","properties":{"reportTime":{"description":"Date and time the report was received.","format":"date-time","type":"string"},"systemRamFreeInfo":{"type":"array","items":{"format":"int64","type":"string"}}}}},"systemRamTotal":{"description":"Total RAM on the device [in bytes] (Read-only)","format":"int64","type":"string"},"tpmVersionInfo":{"description":"Trusted Platform Module (TPM) (Read-only)","type":"object","properties":{"family":{"description":"TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: \"1.2\" -> 312e3200 TPM 2.0: \"2.0\" -> 322e3000","type":"string"},"firmwareVersion":{"description":"TPM firmware version.","type":"string"},"manufacturer":{"description":"TPM manufacturer code.","type":"string"},"specLevel":{"description":"TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.","type":"string"},"tpmModel":{"description":"TPM model number.","type":"string"},"vendorSpecific":{"description":"Vendor-specific information such as Vendor ID.","type":"string"}}},"willAutoRenew":{"description":"Determines if the device will auto renew its support after the support end date. This is a read-only property.","type":"boolean"}}},"admin_directory_v1_ChromeOsDeviceAction":{"description":"Data about an update to the status of a Chrome OS device.","type":"object","properties":{"action":{"description":"Action to be taken on the Chrome OS device.","type":"string"},"deprovisionReason":{"description":"Only used when the action is `deprovision`. With the `deprovision` action, this field is required. *Note*: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.","type":"string"}}},"admin_directory_v1_ChromeOsDevices":{"type":"object","properties":{"chromeosdevices":{"description":"A list of Chrome OS Device objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#chromeosdevices","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request.","type":"string"}}},"admin_directory_v1_ChromeOsMoveDevicesToOu":{"type":"object","properties":{"deviceIds":{"description":"Chrome OS devices to be moved to OU","type":"array","items":{"type":"string"}}}},"admin_directory_v1_CountChromeOsDevicesResponse":{"description":"A response for counting ChromeOS devices.","type":"object","properties":{"count":{"description":"The total number of devices matching the request.","format":"int64","type":"string"}}},"admin_directory_v1_CreatePrintServerRequest":{"description":"Request for adding a new print server.","type":"object","properties":{"parent":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"printServer":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}},"admin_directory_v1_CreatePrinterRequest":{"description":"Request for adding a new printer.","type":"object","properties":{"parent":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"printer":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}},"admin_directory_v1_Customer":{"type":"object","properties":{"alternateEmail":{"description":"The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain`","type":"string"},"customerCreationTime":{"description":"The customer's creation time (Readonly)","format":"date-time","type":"string"},"customerDomain":{"description":"The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID for the customer's Google Workspace account. (Readonly)","type":"string"},"kind":{"description":"Identifies the resource as a customer. Value: `admin#directory#customer`","default":"admin#directory#customer","type":"string"},"language":{"description":"The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.","type":"string"},"phoneNumber":{"description":"The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/admin_directory_v1_CustomerPostalAddress"}}},"admin_directory_v1_CustomerPostalAddress":{"type":"object","properties":{"addressLine1":{"description":"A customer's physical address. The address can be composed of one to three lines.","type":"string"},"addressLine2":{"description":"Address line 2 of the address.","type":"string"},"addressLine3":{"description":"Address line 3 of the address.","type":"string"},"contactName":{"description":"The customer contact's name.","type":"string"},"countryCode":{"description":"This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).","type":"string"},"locality":{"description":"Name of the locality. An example of a locality value is the city of `San Francisco`.","type":"string"},"organizationName":{"description":"The company or company division name.","type":"string"},"postalCode":{"description":"The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.","type":"string"},"region":{"description":"Name of the region. An example of a region value is `NY` for the state of New York.","type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesCommand":{"description":"Information regarding a command that was issued to a device.","type":"object","properties":{"commandExpireTime":{"description":"The time at which the command will expire. If the device doesn't execute the command within this time the command will become expired.","format":"google-datetime","type":"string"},"commandId":{"description":"Unique ID of a device command.","format":"int64","type":"string"},"commandResult":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesCommandResult"},"issueTime":{"description":"The timestamp when the command was issued by the admin.","format":"google-datetime","type":"string"},"payload":{"description":"The payload that the command specified, if any.","type":"string"},"state":{"description":"Indicates the command state.","enum":["STATE_UNSPECIFIED","PENDING","EXPIRED","CANCELLED","SENT_TO_CLIENT","ACKED_BY_CLIENT","EXECUTED_BY_CLIENT"],"type":"string"},"type":{"description":"The type of the command.","enum":["COMMAND_TYPE_UNSPECIFIED","REBOOT","TAKE_A_SCREENSHOT","SET_VOLUME","WIPE_USERS","REMOTE_POWERWASH","DEVICE_START_CRD_SESSION","CAPTURE_LOGS","FETCH_CRD_AVAILABILITY_INFO","FETCH_SUPPORT_PACKET"],"type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesCommandResult":{"description":"The result of executing a command.","type":"object","properties":{"commandResultPayload":{"description":"The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { \"url\": url }. The provided URL links to the Chrome Remote Desktop session and requires authentication using only the `email` associated with the command's issuance. * `FETCH_CRD_AVAILABILITY_INFO`: Payload is a stringified JSON object in the form: { \"deviceIdleTimeInSeconds\": number, \"userSessionType\": string, \"remoteSupportAvailability\": string, \"remoteAccessAvailability\": string }. The \"remoteSupportAvailability\" field is set to \"AVAILABLE\" if `shared` CRD session to the device is available. The \"remoteAccessAvailability\" field is set to \"AVAILABLE\" if `private` CRD session to the device is available.","type":"string"},"errorMessage":{"description":"The error message with a short explanation as to why the command failed. Only present if the command failed.","type":"string"},"executeTime":{"description":"The time at which the command was executed or failed to execute.","format":"google-datetime","type":"string"},"result":{"description":"The result of the command.","enum":["COMMAND_RESULT_TYPE_UNSPECIFIED","IGNORED","FAILURE","SUCCESS"],"type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesIssueCommandRequest":{"description":"A request for issuing a command.","type":"object","properties":{"commandType":{"description":"The type of command.","enum":["COMMAND_TYPE_UNSPECIFIED","REBOOT","TAKE_A_SCREENSHOT","SET_VOLUME","WIPE_USERS","REMOTE_POWERWASH","DEVICE_START_CRD_SESSION","CAPTURE_LOGS","FETCH_CRD_AVAILABILITY_INFO","FETCH_SUPPORT_PACKET"],"type":"string"},"payload":{"description":"The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true, \"crdSessionType\": string }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. `crdSessionType` can only select from values `private` (which grants the remote admin exclusive control of the ChromeOS device) or `shared` (which allows the admin and the local user to share control of the ChromeOS device). If not set, `crdSessionType` defaults to `shared`. The `FETCH_CRD_AVAILABILITY_INFO` command can be used to determine available session types on the device. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The `user_session_delay_seconds` is the amount of seconds to wait before rebooting the device if a user is logged in. It has to be an integer in the range [0,300]. When payload is not present for reboot, 0 delay is the default. Note: This only applies if an actual user is logged in, including a Guest. If the device is in the login screen or in Kiosk mode the value is not respected and the device immediately reboots. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {\"supportPacketDetails\":{ \"issueCaseId\": optional_support_case_id_string, \"issueDescription\": optional_issue_description_string, \"requestedDataCollectors\": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log).","type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesIssueCommandResponse":{"description":"A response for issuing a command.","type":"object","properties":{"commandId":{"description":"The unique ID of the issued command, used to retrieve the command status.","format":"int64","type":"string"}}},"admin_directory_v1_DirectoryUsersCreateGuestRequest":{"description":"Directory users guest creation request message.","type":"object","properties":{"customer":{"description":"Optional. Immutable ID of the Google Workspace account. Only required when request is created by a service account. Defaults to the authenticated user's customer ID otherwise.","type":"string"},"primaryGuestEmail":{"description":"Required. External email of the guest user being created.","type":"string"}}},"admin_directory_v1_DomainAlias":{"type":"object","properties":{"creationTime":{"description":"The creation time of the domain alias. (Read-only).","format":"int64","type":"string"},"domainAliasName":{"description":"The domain alias name.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domainAlias","type":"string"},"parentDomainName":{"description":"The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.","type":"string"},"verified":{"description":"Indicates the verification state of a domain alias. (Read-only)","type":"boolean"}}},"admin_directory_v1_DomainAliases":{"type":"object","properties":{"domainAliases":{"description":"A list of domain alias objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domainAliases","type":"string"}}},"admin_directory_v1_Domains":{"type":"object","properties":{"creationTime":{"description":"Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only).","format":"int64","type":"string"},"domainAliases":{"description":"A list of domain alias objects. (Read-only)","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}},"domainName":{"description":"The domain name of the customer.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"isPrimary":{"description":"Indicates if the domain is a primary domain (Read-only).","type":"boolean"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domain","type":"string"},"verified":{"description":"Indicates the verification state of a domain. (Read-only).","type":"boolean"}}},"admin_directory_v1_Domains2":{"type":"object","properties":{"domains":{"description":"A list of domain objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domains","type":"string"}}},"admin_directory_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"admin_directory_v1_ExpirationDetails":{"description":"Details regarding the expiration of this role assignment. Used to automatically revoke access when the time limit is reached.","type":"object","properties":{"expireTime":{"description":"The specific timestamp when the role assignment expires.","format":"google-datetime","type":"string"}}},"admin_directory_v1_ExternalId":{"description":"External identifier used to link and identify this group across external directory systems.","type":"object","properties":{"id":{"description":"The unique identifier string assigned by the external provider.","type":"string"},"namespace":{"description":"The system or identity provider managing this ID.","type":"string"}}},"admin_directory_v1_FailureInfo":{"description":"Info about failures","type":"object","properties":{"errorCode":{"description":"Canonical code for why the update failed to apply.","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"type":"string"},"errorMessage":{"description":"Failure reason message.","type":"string"},"printer":{"$ref":"#/components/schemas/admin_directory_v1_Printer"},"printerId":{"description":"Id of a failed printer.","type":"string"}}},"admin_directory_v1_FanInfo":{"description":"Information about the device's fan.","type":"object","properties":{"speedRpm":{"description":"Output only. Fan speed in RPM.","format":"int32","readOnly":true,"type":"integer"}}},"admin_directory_v1_Feature":{"description":"JSON template for Feature object in Directory API.","type":"object","properties":{"etags":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#features#Feature","type":"string"},"name":{"description":"The name of the feature.","type":"string"}}},"admin_directory_v1_FeatureInstance":{"description":"JSON template for a feature instance.","type":"object","properties":{"feature":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}},"admin_directory_v1_FeatureRename":{"type":"object","properties":{"newName":{"description":"New name of the feature.","type":"string"}}},"admin_directory_v1_Features":{"description":"Public API: Resources.features","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"features":{"description":"The Features in this page of results.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#features#featuresList","type":"string"},"nextPageToken":{"description":"The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.","type":"string"}}},"admin_directory_v1_Group":{"description":"Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.","type":"object","properties":{"adminCreated":{"description":"Read-only. Value is `true` if this group was created by an administrator rather than a user.","type":"boolean"},"aliases":{"description":"Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.","type":"array","items":{"type":"string"}},"description":{"description":"An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.","type":"string"},"directMembersCount":{"description":"The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.","format":"int64","type":"string"},"email":{"description":"The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"externalIds":{"description":"Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_ExternalId"}},"id":{"description":"Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.","type":"string"},"kind":{"description":"The type of the API resource. For Groups resources, the value is `admin#directory#group`.","default":"admin#directory#group","type":"string"},"name":{"description":"The group's display name.","type":"string"},"nonEditableAliases":{"description":"Read-only. The list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_GroupAlias":{"description":"The Directory API manages aliases, which are alternative email addresses.","type":"object","properties":{"alias":{"description":"The alias email address.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID of the group.","type":"string"},"kind":{"description":"The type of the API resource. For Alias resources, the value is `admin#directory#alias`.","type":"string"},"primaryEmail":{"description":"The primary email address of the group.","type":"string"}}},"admin_directory_v1_Groups":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"groups":{"description":"A list of group objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Group"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#groups","type":"string"},"nextPageToken":{"description":"Token used to access next page of this result.","type":"string"}}},"admin_directory_v1_GuestAccountInfo":{"description":"Account info specific to Guest users.","type":"object","properties":{"primaryGuestEmail":{"description":"Immutable. The guest's external email.","type":"string"}}},"admin_directory_v1_ListPrintServersResponse":{"type":"object","properties":{"nextPageToken":{"description":"A token that can be sent as `page_token` in a request to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"printServers":{"description":"List of print servers.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"admin_directory_v1_ListPrinterModelsResponse":{"description":"Response for listing allowed printer models.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"printerModels":{"description":"Printer models that are currently allowed to be configured for ChromeOs. Some printers may be added or removed over time.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrinterModel"}}}},"admin_directory_v1_ListPrintersResponse":{"description":"Response for listing printers.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"printers":{"description":"List of printers. If `org_unit_id` was given in the request, then only printers visible for this OU will be returned. If `org_unit_id` was not given in the request, then all printers will be returned.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"admin_directory_v1_Member":{"description":"A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).","type":"object","properties":{"delivery_settings":{"description":"Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.","type":"string"},"email":{"description":"The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.","type":"string"},"kind":{"description":"The type of the API resource. For Members resources, the value is `admin#directory#member`.","default":"admin#directory#member","type":"string"},"role":{"description":"The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).","type":"string"},"status":{"description":"Status of member (Immutable)","type":"string"},"type":{"description":"The type of group member.","type":"string"}}},"admin_directory_v1_Members":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#members","type":"string"},"members":{"description":"A list of member objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Member"}},"nextPageToken":{"description":"Token used to access next page of this result.","type":"string"}}},"admin_directory_v1_MembersHasMember":{"description":"JSON template for Has Member response in Directory API.","type":"object","properties":{"isMember":{"description":"Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested.","readOnly":true,"type":"boolean"}}},"admin_directory_v1_MobileDevice":{"description":"Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices.html).","type":"object","properties":{"adbStatus":{"description":"Adb (USB debugging) enabled or disabled on device (Read-only)","type":"boolean"},"applications":{"description":"The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.","type":"array","items":{"type":"object","properties":{"displayName":{"description":"The application's display name. An example is `Browser`.","type":"string"},"packageName":{"description":"The application's package name. An example is `com.android.browser`.","type":"string"},"permission":{"description":"The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's [Android manifest](https://developer.android.com/guide/topics/manifest/uses-permission-element.html). Examples of a Calendar application's permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`.","type":"array","items":{"type":"string"}},"versionCode":{"description":"The application's version code. An example is `13`.","format":"int32","type":"integer"},"versionName":{"description":"The application's version name. An example is `3.2-140714`.","type":"string"}}}},"basebandVersion":{"description":"The device's baseband version.","type":"string"},"bootloaderVersion":{"description":"Mobile Device Bootloader version (Read-only)","type":"string"},"brand":{"description":"Mobile Device Brand (Read-only)","type":"string"},"buildNumber":{"description":"The device's operating system build number.","type":"string"},"defaultLanguage":{"description":"The default locale used on the device.","type":"string"},"developerOptionsStatus":{"description":"Developer options enabled or disabled on device (Read-only)","type":"boolean"},"deviceCompromisedStatus":{"description":"The compromised device status.","type":"string"},"deviceId":{"description":"The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.","type":"string"},"devicePasswordStatus":{"description":"DevicePasswordStatus (Read-only)","type":"string"},"email":{"description":"The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method.","type":"array","items":{"type":"string"}},"encryptionStatus":{"description":"Mobile Device Encryption Status (Read-only)","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"firstSync":{"description":"Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)","format":"date-time","type":"string"},"hardware":{"description":"Mobile Device Hardware (Read-only)","type":"string"},"hardwareId":{"description":"The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.","type":"string"},"imei":{"description":"The device's IMEI number.","type":"string"},"kernelVersion":{"description":"The device's kernel version.","type":"string"},"kind":{"description":"The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.","default":"admin#directory#mobiledevice","type":"string"},"lastSync":{"description":"Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)","format":"date-time","type":"string"},"managedAccountIsOnOwnerProfile":{"description":"Boolean indicating if this account is on owner/primary profile or not.","type":"boolean"},"manufacturer":{"description":"Mobile Device manufacturer (Read-only)","type":"string"},"meid":{"description":"The device's MEID number.","type":"string"},"model":{"description":"The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device).","type":"string"},"name":{"description":"The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user).","type":"array","items":{"type":"string"}},"networkOperator":{"description":"Mobile Device mobile or network operator (if available) (Read-only)","type":"string"},"os":{"description":"The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).","type":"string"},"otherAccountsInfo":{"description":"The list of accounts added on device (Read-only)","type":"array","items":{"type":"string"}},"privilege":{"description":"DMAgentPermission (Read-only)","type":"string"},"releaseVersion":{"description":"Mobile Device release version version (Read-only)","type":"string"},"resourceId":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"},"securityPatchLevel":{"description":"Mobile Device Security patch level (Read-only)","format":"int64","type":"string"},"serialNumber":{"description":"The device's serial number.","type":"string"},"status":{"description":"The device's status.","type":"string"},"supportsWorkProfile":{"description":"Work profile supported on device (Read-only)","type":"boolean"},"type":{"description":"The type of mobile device.","type":"string"},"unknownSourcesStatus":{"description":"Unknown sources enabled or disabled on device (Read-only)","type":"boolean"},"userAgent":{"description":"Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).","type":"string"},"wifiMacAddress":{"description":"The device's MAC address on Wi-Fi networks.","type":"string"}}},"admin_directory_v1_MobileDeviceAction":{"type":"object","properties":{"action":{"description":"The action to be performed on the device.","type":"string"}}},"admin_directory_v1_MobileDevices":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#mobiledevices","type":"string"},"mobiledevices":{"description":"A list of Mobile Device objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_MobileDevice"}},"nextPageToken":{"description":"Token used to access next page of this result.","type":"string"}}},"admin_directory_v1_OrgUnit":{"description":"Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.","type":"object","properties":{"blockInheritance":{"description":"This field is deprecated and setting its value has no effect.","type":"boolean"},"description":{"description":"Description of the organizational unit.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.","default":"admin#directory#orgUnit","type":"string"},"name":{"description":"The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.","type":"string"},"orgUnitId":{"description":"The unique ID of the organizational unit.","type":"string"},"orgUnitPath":{"description":"The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).","type":"string"},"parentOrgUnitId":{"description":"The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.","type":"string"},"parentOrgUnitPath":{"description":"The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.","type":"string"}}},"admin_directory_v1_OrgUnits":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.","default":"admin#directory#orgUnits","type":"string"},"organizationUnits":{"description":"A list of organizational unit objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"admin_directory_v1_OsUpdateStatus":{"description":"Contains information regarding the current OS update status.","type":"object","properties":{"rebootTime":{"description":"Date and time of the last reboot.","type":"string"},"state":{"description":"The update state of an OS update.","enum":["updateStateUnspecified","updateStateNotStarted","updateStateDownloadInProgress","updateStateNeedReboot"],"type":"string"},"targetKioskAppVersion":{"description":"New required platform version from the pending updated kiosk app.","type":"string"},"targetOsVersion":{"description":"New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy \"0.0.0.0\" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.","type":"string"},"updateCheckTime":{"description":"Date and time of the last update check.","type":"string"},"updateTime":{"description":"Date and time of the last successful OS update.","type":"string"}}},"admin_directory_v1_PrintServer":{"description":"Configuration for a print server.","type":"object","properties":{"createTime":{"description":"Output only. Time when the print server was created.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Editable. Description of the print server (as shown in the Admin console).","type":"string"},"displayName":{"description":"Editable. Display name of the print server (as shown in the Admin console).","type":"string"},"id":{"description":"Immutable. ID of the print server. Leave empty when creating.","type":"string"},"name":{"description":"Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","type":"string"},"orgUnitId":{"description":"ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).","type":"string"},"uri":{"description":"Editable. Print server URI.","type":"string"}}},"admin_directory_v1_PrintServerFailureInfo":{"description":"Info about failures","type":"object","properties":{"errorCode":{"description":"Canonical code for why the update failed to apply.","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"type":"string"},"errorMessage":{"description":"Failure reason message.","type":"string"},"printServer":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"},"printServerId":{"description":"ID of a failed print server.","type":"string"}}},"admin_directory_v1_Printer":{"description":"Printer configuration.","type":"object","properties":{"auxiliaryMessages":{"description":"Output only. Auxiliary messages about issues with the printer configuration if any.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_AuxiliaryMessage"}},"createTime":{"description":"Output only. Time when printer was created.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Editable. Description of printer.","type":"string"},"displayName":{"description":"Editable. Name of printer.","type":"string"},"id":{"description":"Id of the printer. (During printer creation leave empty)","type":"string"},"makeAndModel":{"description":"Editable. Make and model of printer. e.g. Lexmark MS610de Value must be in format as seen in ListPrinterModels response.","type":"string"},"name":{"description":"Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","type":"string"},"orgUnitId":{"description":"Organization Unit that owns this printer (Only can be set during Printer creation)","type":"string"},"uri":{"description":"Editable. Printer URI.","type":"string"},"useDriverlessConfig":{"description":"Editable. flag to use driverless configuration or not. If it's set to be true, make_and_model can be ignored","type":"boolean"}}},"admin_directory_v1_PrinterModel":{"description":"Printer manufacturer and model","type":"object","properties":{"displayName":{"description":"Display name. eq. \"Brother MFC-8840D\"","type":"string"},"makeAndModel":{"description":"Make and model as represented in \"make_and_model\" field in Printer object. eq. \"brother mfc-8840d\"","type":"string"},"manufacturer":{"description":"Manufacturer. eq. \"Brother\"","type":"string"}}},"admin_directory_v1_Privilege":{"type":"object","properties":{"childPrivileges":{"description":"A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Privilege"}},"etag":{"description":"ETag of the resource.","type":"string"},"isOuScopable":{"description":"If the privilege can be restricted to an organization unit.","type":"boolean"},"kind":{"description":"The type of the API resource. This is always `admin#directory#privilege`.","default":"admin#directory#privilege","type":"string"},"privilegeName":{"description":"The name of the privilege.","type":"string"},"serviceId":{"description":"The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).","type":"string"},"serviceName":{"description":"The name of the service this privilege is for.","type":"string"}}},"admin_directory_v1_Privileges":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of Privilege resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Privilege"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#privileges`.","default":"admin#directory#privileges","type":"string"}}},"admin_directory_v1_Role":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"isSuperAdminRole":{"description":"Returns `true` if the role is a super admin role.","type":"boolean"},"isSystemRole":{"description":"Returns `true` if this is a pre-defined system role.","type":"boolean"},"kind":{"description":"The type of the API resource. This is always `admin#directory#role`.","default":"admin#directory#role","type":"string"},"roleDescription":{"description":"A short description of the role.","type":"string"},"roleId":{"description":"ID of the role.","format":"int64","type":"string"},"roleName":{"description":"Name of the role.","type":"string"},"rolePrivileges":{"description":"The set of privileges that are granted to this role.","type":"array","items":{"type":"object","properties":{"privilegeName":{"description":"The name of the privilege.","type":"string"},"serviceId":{"description":"The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).","type":"string"}}}}}},"admin_directory_v1_RoleAssignment":{"description":"Defines an assignment of a role.","type":"object","properties":{"assignedTo":{"description":"The unique ID of the entity this role is assigned to—either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).","type":"string"},"assigneeType":{"description":"Output only. The type of the assignee (`USER` or `GROUP`).","readOnly":true,"enum":["user","group"],"type":"string"},"condition":{"description":"Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"expirationDetails":{"$ref":"#/components/schemas/admin_directory_v1_ExpirationDetails"},"kind":{"description":"The type of the API resource. This is always `admin#directory#roleAssignment`.","default":"admin#directory#roleAssignment","type":"string"},"orgUnitId":{"description":"If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.","type":"string"},"roleAssignmentId":{"description":"ID of this roleAssignment.","format":"int64","type":"string"},"roleId":{"description":"The ID of the role that is assigned.","format":"int64","type":"string"},"scopeType":{"description":"The scope in which this role is assigned.","type":"string"}}},"admin_directory_v1_RoleAssignments":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of RoleAssignment resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#roleAssignments`.","default":"admin#directory#roleAssignments","type":"string"},"nextPageToken":{"type":"string"}}},"admin_directory_v1_Roles":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of Role resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Role"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#roles`.","default":"admin#directory#roles","type":"string"},"nextPageToken":{"type":"string"}}},"admin_directory_v1_Schema":{"description":"The type of API resource. For Schema resources, this is always `admin#directory#schema`.","type":"object","properties":{"displayName":{"description":"Display name for the schema.","type":"string"},"etag":{"description":"The ETag of the resource.","type":"string"},"fields":{"description":"A list of fields in the schema.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_SchemaFieldSpec"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#schema","type":"string"},"schemaId":{"description":"The unique identifier of the schema (Read-only)","type":"string"},"schemaName":{"description":"The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.","type":"string"}}},"admin_directory_v1_SchemaFieldSpec":{"description":"You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).","type":"object","properties":{"displayName":{"description":"Display Name of the field.","type":"string"},"etag":{"description":"The ETag of the field.","type":"string"},"fieldId":{"description":"The unique identifier of the field (Read-only)","type":"string"},"fieldName":{"description":"The name of the field.","type":"string"},"fieldType":{"description":"The type of the field.","type":"string"},"indexed":{"description":"Boolean specifying whether the field is indexed or not. Default: `true`.","default":true,"type":"boolean"},"kind":{"description":"The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.","default":"admin#directory#schema#fieldspec","type":"string"},"multiValued":{"description":"A boolean specifying whether this is a multi-valued field or not. Default: `false`.","type":"boolean"},"numericIndexingSpec":{"description":"Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.","type":"object","properties":{"maxValue":{"description":"Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.","format":"double","type":"number"},"minValue":{"description":"Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.","format":"double","type":"number"}}},"readAccessType":{"description":"Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.","default":"ALL_DOMAIN_USERS","type":"string"}}},"admin_directory_v1_Schemas":{"description":"JSON response template for List Schema operation in Directory API.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#schemas","type":"string"},"schemas":{"description":"A list of UserSchema objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"admin_directory_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"admin_directory_v1_Token":{"description":"JSON template for token resource in Directory API.","type":"object","properties":{"anonymous":{"description":"Whether the application is registered with Google. The value is `true` if the application has an anonymous Client ID.","type":"boolean"},"clientId":{"description":"The Client ID of the application the token is issued to.","type":"string"},"displayText":{"description":"The displayable name of the application the token is issued to.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the API resource. This is always `admin#directory#token`.","default":"admin#directory#token","type":"string"},"nativeApp":{"description":"Whether the token is issued to an installed application. The value is `true` if the application is installed to a desktop or mobile device.","type":"boolean"},"scopes":{"description":"A list of authorization scopes the application is granted.","type":"array","items":{"type":"string"}},"userKey":{"description":"The unique ID of the user that issued the token.","type":"string"}}},"admin_directory_v1_Tokens":{"description":"JSON response template for List tokens operation in Directory API.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of Token resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Token"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#tokenList`.","default":"admin#directory#tokenList","type":"string"}}},"admin_directory_v1_User":{"description":"The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).","type":"object","properties":{"addresses":{"description":"The list of the user's addresses. The maximum allowed data size for this field is 10KB."},"agreedToTerms":{"description":"Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.","readOnly":true,"type":"boolean"},"aliases":{"description":"Output only. The list of the user's alias email addresses.","readOnly":true,"type":"array","items":{"type":"string"}},"archivalTime":{"description":"Output only. User's account archival time. (Read-only)","readOnly":true,"type":"string"},"archived":{"description":"Indicates if user is archived.","type":"boolean"},"changePasswordAtNextLogin":{"description":"Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224).","type":"boolean"},"creationTime":{"description":"User's G Suite account creation time. (Read-only)","format":"date-time","readOnly":true,"type":"string"},"customSchemas":{"description":"Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.","type":"object","additionalProperties":{"$ref":"#/components/schemas/admin_directory_v1_UserCustomProperties"}},"customerId":{"description":"Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.","readOnly":true,"type":"string"},"deletionTime":{"format":"date-time","readOnly":true,"type":"string"},"emails":{"description":"The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`."},"etag":{"description":"Output only. ETag of the resource.","readOnly":true,"type":"string"},"externalIds":{"description":"The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB."},"gender":{"description":"The user's gender. The maximum allowed data size for this field is 1KB."},"guestAccountInfo":{"$ref":"#/components/schemas/admin_directory_v1_GuestAccountInfo"},"hashFunction":{"description":"Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.","type":"string"},"id":{"description":"The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.","type":"string"},"ims":{"description":"The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB."},"includeInGlobalAddressList":{"description":"Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).","type":"boolean"},"ipWhitelisted":{"description":"If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.","type":"boolean"},"isAdmin":{"description":"Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.","readOnly":true,"type":"boolean"},"isDelegatedAdmin":{"description":"Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).","readOnly":true,"type":"boolean"},"isEnforcedIn2Sv":{"description":"Output only. Is 2-step verification enforced (Read-only)","readOnly":true,"type":"boolean"},"isEnrolledIn2Sv":{"description":"Output only. Is enrolled in 2-step verification (Read-only)","readOnly":true,"type":"boolean"},"isGuestUser":{"description":"Immutable. Indicates if the inserted user is a guest.","type":"boolean"},"isMailboxSetup":{"description":"Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.","readOnly":true,"type":"boolean"},"keywords":{"description":"The list of the user's keywords. The maximum allowed data size for this field is 1KB."},"kind":{"description":"Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.","readOnly":true,"default":"admin#directory#user","type":"string"},"languages":{"description":"The user's languages. The maximum allowed data size for this field is 1KB."},"lastLoginTime":{"description":"User's last login time. (Read-only)","format":"date-time","readOnly":true,"type":"string"},"locations":{"description":"The user's locations. The maximum allowed data size for this field is 10KB."},"name":{"$ref":"#/components/schemas/admin_directory_v1_UserName"},"nonEditableAliases":{"description":"Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.","readOnly":true,"type":"array","items":{"type":"string"}},"notes":{"description":"Notes for the user."},"orgUnitPath":{"description":"The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`).","type":"string"},"organizations":{"description":"The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB."},"password":{"description":"User's password","type":"string"},"phones":{"description":"The list of the user's phone numbers. The maximum allowed data size for this field is 1KB."},"posixAccounts":{"description":"The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user."},"primaryEmail":{"description":"The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another 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":{"description":"The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB."},"sshPublicKeys":{"description":"A list of SSH public keys."},"suspended":{"description":"Indicates if user is suspended.","type":"boolean"},"suspensionReason":{"description":"Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`.","readOnly":true,"type":"string"},"suspensionTime":{"description":"Output only. User's account suspension time. (Read-only)","readOnly":true,"type":"string"},"thumbnailPhotoEtag":{"description":"Output only. ETag of the user's photo (Read-only)","readOnly":true,"type":"string"},"thumbnailPhotoUrl":{"description":"Output only. The URL of the user's profile photo. The URL might be temporary or private.","readOnly":true,"type":"string"},"websites":{"description":"The user's websites. The maximum allowed data size for this field is 2KB."}}},"admin_directory_v1_UserAbout":{"description":"JSON template for About (notes) of a user in Directory API.","type":"object","properties":{"contentType":{"description":"About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text.","type":"string"},"value":{"description":"Actual value of notes.","type":"string"}}},"admin_directory_v1_UserAddress":{"description":"JSON template for address.","type":"object","properties":{"country":{"description":"Country.","type":"string"},"countryCode":{"description":"Country code.","type":"string"},"customType":{"description":"Custom type.","type":"string"},"extendedAddress":{"description":"Extended Address.","type":"string"},"formatted":{"description":"Formatted address.","type":"string"},"locality":{"description":"Locality.","type":"string"},"poBox":{"description":"Other parts of address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"primary":{"description":"If this is user's primary address. Only one entry could be marked as primary.","type":"boolean"},"region":{"description":"Region.","type":"string"},"sourceIsStructured":{"description":"User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses but any values will eventually be clobbered.","type":"boolean"},"streetAddress":{"description":"Street.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard values of that entry. For example address could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserAlias":{"description":"The Directory API manages aliases, which are alternative email addresses.","type":"object","properties":{"alias":{"description":"The alias email address.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID for the user.","type":"string"},"kind":{"description":"The type of the API resource. For Alias resources, the value is `admin#directory#alias`.","type":"string"},"primaryEmail":{"description":"The user's primary email address.","type":"string"}}},"admin_directory_v1_UserCustomProperties":{"description":"JSON template for a set of custom properties (i.e. all fields in a particular schema)","type":"object","additionalProperties":{}},"admin_directory_v1_UserEmail":{"description":"JSON template for an email.","type":"object","properties":{"address":{"description":"Email id of the user.","type":"string"},"customType":{"description":"Custom Type.","type":"string"},"primary":{"description":"If this is user's primary email. Only one entry could be marked as primary.","type":"boolean"},"public_key_encryption_certificates":{"description":"Public Key Encryption Certificates. Current limit: 1 per email address, and 5 per user.","type":"object","properties":{"certificate":{"description":"X.509 encryption certificate in `PEM` format. Must only be an end-entity (leaf) certificate.","type":"string"},"is_default":{"description":"Whether this is the default certificate for the given email address.","type":"boolean"},"state":{"description":"Denotes the certificate's state in its lifecycle. Possible values are `not_yet_validated`, `valid`, `invalid`, `expired`, and `revoked`.","type":"string"}}},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserExternalId":{"description":"JSON template for an externalId entry.","type":"object","properties":{"customType":{"description":"Custom type.","type":"string"},"type":{"description":"The type of the Id.","type":"string"},"value":{"description":"The value of the id.","type":"string"}}},"admin_directory_v1_UserGender":{"type":"object","properties":{"addressMeAs":{"description":"AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans for example he/him/his or they/them/their.","type":"string"},"customGender":{"description":"Custom gender.","type":"string"},"type":{"description":"Gender.","type":"string"}}},"admin_directory_v1_UserIm":{"description":"JSON template for instant messenger of an user.","type":"object","properties":{"customProtocol":{"description":"Custom protocol.","type":"string"},"customType":{"description":"Custom type.","type":"string"},"im":{"description":"Instant messenger id.","type":"string"},"primary":{"description":"If this is user's primary im. Only one entry could be marked as primary.","type":"boolean"},"protocol":{"description":"Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type it can take a CUSTOM value and specify the custom name in customProtocol field.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserKeyword":{"description":"JSON template for a keyword entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard type of that entry. For example keyword could be of type occupation or outlook. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"},"value":{"description":"Keyword.","type":"string"}}},"admin_directory_v1_UserLanguage":{"description":"JSON template for a language entry.","type":"object","properties":{"customLanguage":{"description":"Other language. User can provide their own language name if there is no corresponding ISO 639 language code. If this is set, `languageCode` can't be set.","type":"string"},"languageCode":{"description":"ISO 639 string representation of a language. See [Language Codes](/admin-sdk/directory/v1/languages) for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. Illegal values cause `SchemaException`. If this is set, `customLanguage` can't be set.","type":"string"},"preference":{"description":"Optional. If present, controls whether the specified `languageCode` is the user's preferred language. If `customLanguage` is set, this can't be set. Allowed values are `preferred` and `not_preferred`.","type":"string"}}},"admin_directory_v1_UserLocation":{"description":"JSON template for a location entry.","type":"object","properties":{"area":{"description":"Required. Textual location. This is most useful for display purposes to concisely describe the location. For example 'Mountain View, CA', 'Near Seattle', 'US-NYC-9TH 9A209A.''","type":"string"},"buildingId":{"description":"Building Identifier.","type":"string"},"customType":{"description":"Custom Type.","type":"string"},"deskCode":{"description":"Most specific textual code of individual desk location.","type":"string"},"floorName":{"description":"Floor name/number.","type":"string"},"floorSection":{"description":"Floor section. More specific location within the floor. For example if a floor is divided into sections 'A', 'B' and 'C' this field would identify one of those values.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type an entry can have a custom type and can give it any name. Such types should have 'custom' as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserMakeAdmin":{"type":"object","properties":{"status":{"description":"Indicates the administrator status of the user.","type":"boolean"}}},"admin_directory_v1_UserName":{"type":"object","properties":{"displayName":{"description":"The user's display name. Limit: 256 characters.","type":"string"},"familyName":{"description":"The user's last name. Required when creating a user account.","type":"string"},"fullName":{"description":"The user's full name formed by concatenating the first and last name values.","type":"string"},"givenName":{"description":"The user's first name. Required when creating a user account.","type":"string"}}},"admin_directory_v1_UserOrganization":{"description":"JSON template for an organization entry.","type":"object","properties":{"costCenter":{"description":"The cost center of the users department.","type":"string"},"customType":{"description":"Custom type.","type":"string"},"department":{"description":"Department within the organization.","type":"string"},"description":{"description":"Description of the organization.","type":"string"},"domain":{"description":"The domain to which the organization belongs to.","type":"string"},"fullTimeEquivalent":{"description":"The full-time equivalent millipercent within the organization (100000 = 100%).","format":"int32","type":"integer"},"location":{"description":"Location of the organization. This need not be fully qualified address.","type":"string"},"name":{"description":"Name of the organization","type":"string"},"primary":{"description":"If it user's primary organization.","type":"boolean"},"symbol":{"description":"Symbol of the organization.","type":"string"},"title":{"description":"Title (designation) of the user in the organization.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example organization could be of school work etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value.","type":"string"}}},"admin_directory_v1_UserPhone":{"description":"JSON template for a phone entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"primary":{"description":"If this is user's primary phone or not.","type":"boolean"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax work mobile etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"},"value":{"description":"Phone number.","type":"string"}}},"admin_directory_v1_UserPhoto":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"height":{"description":"Height of the photo in pixels.","format":"int32","type":"integer"},"id":{"description":"The ID the API uses to uniquely identify the user.","type":"string"},"kind":{"description":"The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.","default":"admin#directory#user#photo","type":"string"},"mimeType":{"description":"The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.","type":"string"},"photoData":{"description":"The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.","format":"byte","type":"string"},"primaryEmail":{"description":"The user's primary email address.","type":"string"},"width":{"description":"Width of the photo in pixels.","format":"int32","type":"integer"}}},"admin_directory_v1_UserPosixAccount":{"description":"JSON template for a POSIX account entry.","type":"object","properties":{"accountId":{"description":"A POSIX account field identifier.","type":"string"},"gecos":{"description":"The GECOS (user information) for this account.","type":"string"},"gid":{"description":"The default group ID.","format":"uint64","type":"string"},"homeDirectory":{"description":"The path to the home directory for this account.","type":"string"},"operatingSystemType":{"description":"The operating system type for this account.","type":"string"},"primary":{"description":"If this is user's primary account within the SystemId.","type":"boolean"},"shell":{"description":"The path to the login shell for this account.","type":"string"},"systemId":{"description":"System identifier for which account Username or Uid apply to.","type":"string"},"uid":{"description":"The POSIX compliant user ID.","format":"uint64","type":"string"},"username":{"description":"The username of the account.","type":"string"}}},"admin_directory_v1_UserRelation":{"description":"JSON template for a relation entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"type":{"description":"The relation of the user. Some of the possible values are mother father sister brother manager assistant partner.","type":"string"},"value":{"description":"The name of the relation.","type":"string"}}},"admin_directory_v1_UserSshPublicKey":{"description":"JSON template for a POSIX account entry.","type":"object","properties":{"expirationTimeUsec":{"description":"An expiration time in microseconds since epoch.","format":"int64","type":"string"},"fingerprint":{"description":"A SHA-256 fingerprint of the SSH public key. (Read-only)","readOnly":true,"type":"string"},"key":{"description":"An SSH public key.","type":"string"}}},"admin_directory_v1_UserUndelete":{"type":"object","properties":{"orgUnitPath":{"description":"OrgUnit of User","type":"string"}}},"admin_directory_v1_UserWebsite":{"description":"JSON template for a website entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"primary":{"description":"If this is user's primary website or not.","type":"boolean"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example website could be of home work blog etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"},"value":{"description":"Website.","type":"string"}}},"admin_directory_v1_Users":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#users","type":"string"},"nextPageToken":{"description":"Token used to access next page of this result. The page token is only valid for three days.","type":"string"},"trigger_event":{"description":"Event that triggered this response (only used in case of Push Response)","type":"string"},"users":{"description":"A list of user objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"admin_directory_v1_VerificationCode":{"description":"The Directory API allows you to view, generate, and invalidate backup verification codes for a user.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the resource. This is always `admin#directory#verificationCode`.","default":"admin#directory#verificationCode","type":"string"},"userId":{"description":"The obfuscated unique ID of the user.","type":"string"},"verificationCode":{"description":"A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.","type":"string"}}},"admin_directory_v1_VerificationCodes":{"description":"JSON response template for list verification codes operation in Directory API.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of verification code resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_VerificationCode"}},"kind":{"description":"The type of the resource. This is always `admin#directory#verificationCodesList`.","default":"admin#directory#verificationCodesList","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/admin.chrome.printers":"","https://www.googleapis.com/auth/admin.directory.customer":"","https://www.googleapis.com/auth/admin.directory.device.chromeos":"","https://www.googleapis.com/auth/admin.directory.device.mobile":"","https://www.googleapis.com/auth/admin.directory.domain":"","https://www.googleapis.com/auth/admin.directory.group":"","https://www.googleapis.com/auth/admin.directory.orgunit":"","https://www.googleapis.com/auth/admin.directory.resource.calendar":"","https://www.googleapis.com/auth/admin.directory.rolemanagement":"","https://www.googleapis.com/auth/admin.directory.user":"","https://www.googleapis.com/auth/admin.directory.user.security":"","https://www.googleapis.com/auth/admin.directory.userschema":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/admin.chrome.printers","https://www.googleapis.com/auth/admin.directory.customer","https://www.googleapis.com/auth/admin.directory.device.chromeos","https://www.googleapis.com/auth/admin.directory.device.mobile","https://www.googleapis.com/auth/admin.directory.domain","https://www.googleapis.com/auth/admin.directory.group","https://www.googleapis.com/auth/admin.directory.orgunit","https://www.googleapis.com/auth/admin.directory.resource.calendar","https://www.googleapis.com/auth/admin.directory.rolemanagement","https://www.googleapis.com/auth/admin.directory.user","https://www.googleapis.com/auth/admin.directory.user.security","https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/admin/directory_v1/rest","service":"admin","version":"directory_v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Admin SDK API","version":"directory_v1","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."},"servers":[{"url":"https://admin.googleapis.com/"}],"paths":{"/admin/directory/v1/customer/{customerId}/devices/chromeos":{"get":{"operationId":"directory.chromeosdevices.list","x-executor-toolPath":"directory.chromeosdevices.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of Chrome OS devices within an account.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeChildOrgunits","in":"query","required":false,"description":"Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","schema":{"description":"Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Value should not exceed 300.","schema":{"description":"Maximum number of results to return. Value should not exceed 300.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Device property to use for sorting results.","schema":{"description":"Device property to use for sorting results.","enum":["annotatedLocation","annotatedUser","lastSync","notes","serialNumber","status"],"type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":false,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response.","schema":{"description":"The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","schema":{"description":"Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","schema":{"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevices"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly","https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu":{"post":{"operationId":"directory.chromeosdevices.moveDevicesToOu","x-executor-toolPath":"directory.chromeosdevices.moveDevicesToOu","tags":["Admin SDK API"],"description":"Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable. ID of the Google Workspace account","schema":{"description":"Immutable. ID of the Google Workspace account","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":true,"description":"Full path of the target organizational unit or its ID","schema":{"description":"Full path of the target organizational unit or its ID","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsMoveDevicesToOu"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}":{"get":{"operationId":"directory.chromeosdevices.get","x-executor-toolPath":"directory.chromeosdevices.get","tags":["Admin SDK API"],"description":"Retrieves a Chrome OS device's properties.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method.","schema":{"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly","https://www.googleapis.com/auth/admin.directory.device.chromeos"]},"put":{"operationId":"directory.chromeosdevices.update","x-executor-toolPath":"directory.chromeosdevices.update","tags":["Admin SDK API"],"description":"Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","schema":{"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]},"patch":{"operationId":"directory.chromeosdevices.patch","x-executor-toolPath":"directory.chromeosdevices.patch","tags":["Admin SDK API"],"description":"Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","schema":{"description":"The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Determines whether the response contains the full list of properties or only a subset.","schema":{"description":"Determines whether the response contains the full list of properties or only a subset.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}":{"get":{"operationId":"admin.customer.devices.chromeos.commands.get","x-executor-toolPath":"admin.customer.devices.chromeos.commands.get","tags":["Admin SDK API"],"description":"Gets command data a specific command issued to the device.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable. ID of the Google Workspace account.","schema":{"description":"Immutable. ID of the Google Workspace account.","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Immutable. ID of Chrome OS Device.","schema":{"description":"Immutable. ID of Chrome OS Device.","type":"string"}},{"name":"commandId","in":"path","required":true,"description":"Immutable. ID of Chrome OS Device Command.","schema":{"description":"Immutable. ID of Chrome OS Device Command.","format":"int64","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesCommand"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly","https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand":{"post":{"operationId":"admin.customer.devices.chromeos.issueCommand","x-executor-toolPath":"admin.customer.devices.chromeos.issueCommand","tags":["Admin SDK API"],"description":"Issues a command for the device to execute.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable. ID of the Google Workspace account.","schema":{"description":"Immutable. ID of the Google Workspace account.","type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Immutable. ID of Chrome OS Device.","schema":{"description":"Immutable. ID of Chrome OS Device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesIssueCommandRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesIssueCommandResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus":{"post":{"operationId":"admin.customer.devices.chromeos.batchChangeStatus","x-executor-toolPath":"admin.customer.devices.chromeos.batchChangeStatus","tags":["Admin SDK API"],"description":"Changes the status of a batch of ChromeOS devices. For more information about changing a ChromeOS device state [Repair, repurpose, or retire ChromeOS devices](https://support.google.com/chrome/a/answer/3523633).","parameters":[{"name":"customerId","in":"path","required":true,"description":"Required. Immutable ID of the Google Workspace account.","schema":{"description":"Required. Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchChangeChromeOsDeviceStatusRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchChangeChromeOsDeviceStatusResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices":{"get":{"operationId":"admin.customer.devices.chromeos.countChromeOsDevices","x-executor-toolPath":"admin.customer.devices.chromeos.countChromeOsDevices","tags":["Admin SDK API"],"description":"Counts ChromeOS devices matching the request.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Required. Immutable ID of the Google Workspace account.","schema":{"description":"Required. Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","schema":{"description":"Optional. Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).","type":"string"},"style":"form","explode":false},{"name":"includeChildOrgunits","in":"query","required":false,"description":"Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","schema":{"description":"Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":false,"description":"Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CountChromeOsDevicesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.chromeos"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly","https://www.googleapis.com/auth/admin.directory.device.chromeos"]}},"/admin/directory/v1/customer/{customerId}/devices/mobile":{"get":{"operationId":"directory.mobiledevices.list","x-executor-toolPath":"directory.mobiledevices.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Max allowed value is 100.","schema":{"description":"Maximum number of results to return. Max allowed value is 100.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Device property to use for sorting results.","schema":{"description":"Device property to use for sorting results.","enum":["deviceId","email","lastSync","model","name","os","status","type"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list","schema":{"description":"Token to specify next page in the list","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Restrict information returned to a set of selected fields.","schema":{"description":"Restrict information returned to a set of selected fields.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators","schema":{"description":"Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","schema":{"description":"Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MobileDevices"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile.action"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile.action","https://www.googleapis.com/auth/admin.directory.device.mobile.readonly","https://www.googleapis.com/auth/admin.directory.device.mobile"]}},"/admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}":{"get":{"operationId":"directory.mobiledevices.get","x-executor-toolPath":"directory.mobiledevices.get","tags":["Admin SDK API"],"description":"Retrieves a mobile device's properties.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"resourceId","in":"path","required":true,"description":"The unique ID the API service uses to identify the mobile device.","schema":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Restrict information returned to a set of selected fields.","schema":{"description":"Restrict information returned to a set of selected fields.","enum":["BASIC","FULL"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MobileDevice"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile.action"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile.action","https://www.googleapis.com/auth/admin.directory.device.mobile.readonly","https://www.googleapis.com/auth/admin.directory.device.mobile"]},"delete":{"operationId":"directory.mobiledevices.delete","x-executor-toolPath":"directory.mobiledevices.delete","tags":["Admin SDK API"],"description":"Removes a mobile device.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"resourceId","in":"path","required":true,"description":"The unique ID the API service uses to identify the mobile device.","schema":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}},"/admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action":{"post":{"operationId":"directory.mobiledevices.action","x-executor-toolPath":"directory.mobiledevices.action","tags":["Admin SDK API"],"description":"Takes an action that affects a mobile device. For example, remotely wiping a device.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"resourceId","in":"path","required":true,"description":"The unique ID the API service uses to identify the mobile device.","schema":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MobileDeviceAction"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile.action"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.device.mobile"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.device.mobile.action","https://www.googleapis.com/auth/admin.directory.device.mobile"]}},"/admin/directory/v1/customer/{customerId}/orgunits":{"get":{"operationId":"directory.orgunits.list","x-executor-toolPath":"directory.orgunits.list","tags":["Admin SDK API"],"description":"Retrieves a list of all organizational units for an account.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitPath","in":"query","required":false,"description":"The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.","schema":{"description":"The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.","default":"","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"type","in":"query","required":false,"description":"Whether to return all sub-organizations or just immediate children.","schema":{"description":"Whether to return all sub-organizations or just immediate children.","enum":["all","children","allIncludingParent"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnits"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit.readonly","https://www.googleapis.com/auth/admin.directory.orgunit"]},"post":{"operationId":"directory.orgunits.insert","x-executor-toolPath":"directory.orgunits.insert","tags":["Admin SDK API"],"description":"Adds an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]}},"/admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath}":{"get":{"operationId":"directory.orgunits.get","x-executor-toolPath":"directory.orgunits.get","tags":["Admin SDK API"],"description":"Retrieves an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit.readonly","https://www.googleapis.com/auth/admin.directory.orgunit"]},"put":{"operationId":"directory.orgunits.update","x-executor-toolPath":"directory.orgunits.update","tags":["Admin SDK API"],"description":"Updates an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]},"delete":{"operationId":"directory.orgunits.delete","x-executor-toolPath":"directory.orgunits.delete","tags":["Admin SDK API"],"description":"Removes an organizational unit.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]},"patch":{"operationId":"directory.orgunits.patch","x-executor-toolPath":"directory.orgunits.patch","tags":["Admin SDK API"],"description":"Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users).","type":"string"}},{"name":"orgUnitPath","in":"path","required":true,"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","schema":{"description":"The full path of the organizational unit (minus the leading `/`) or its unique ID.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.orgunit"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.orgunit"]}},"/admin/directory/v1/customer/{customerId}/schemas":{"get":{"operationId":"directory.schemas.list","x-executor-toolPath":"directory.schemas.list","tags":["Admin SDK API"],"description":"Retrieves all schemas for a customer.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schemas"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema.readonly","https://www.googleapis.com/auth/admin.directory.userschema"]},"post":{"operationId":"directory.schemas.insert","x-executor-toolPath":"directory.schemas.insert","tags":["Admin SDK API"],"description":"Creates a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]}},"/admin/directory/v1/customer/{customerId}/schemas/{schemaKey}":{"get":{"operationId":"directory.schemas.get","x-executor-toolPath":"directory.schemas.get","tags":["Admin SDK API"],"description":"Retrieves a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema.readonly","https://www.googleapis.com/auth/admin.directory.userschema"]},"put":{"operationId":"directory.schemas.update","x-executor-toolPath":"directory.schemas.update","tags":["Admin SDK API"],"description":"Updates a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]},"delete":{"operationId":"directory.schemas.delete","x-executor-toolPath":"directory.schemas.delete","tags":["Admin SDK API"],"description":"Deletes a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]},"patch":{"operationId":"directory.schemas.patch","x-executor-toolPath":"directory.schemas.patch","tags":["Admin SDK API"],"description":"Patches a schema.","parameters":[{"name":"customerId","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"schemaKey","in":"path","required":true,"description":"Name or immutable ID of the schema.","schema":{"description":"Name or immutable ID of the schema.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.userschema"]}},"/admin/directory/v1/customer/{customer}/domainaliases":{"get":{"operationId":"directory.domainAliases.list","x-executor-toolPath":"directory.domainAliases.list","tags":["Admin SDK API"],"description":"Lists the domain aliases of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parentDomainName","in":"query","required":false,"description":"Name of the parent domain for which domain aliases are to be fetched.","schema":{"description":"Name of the parent domain for which domain aliases are to be fetched.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAliases"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain.readonly","https://www.googleapis.com/auth/admin.directory.domain"]},"post":{"operationId":"directory.domainAliases.insert","x-executor-toolPath":"directory.domainAliases.insert","tags":["Admin SDK API"],"description":"Inserts a domain alias of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}":{"get":{"operationId":"directory.domainAliases.get","x-executor-toolPath":"directory.domainAliases.get","tags":["Admin SDK API"],"description":"Retrieves a domain alias of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"domainAliasName","in":"path","required":true,"description":"Name of domain alias to be retrieved.","schema":{"description":"Name of domain alias to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain.readonly","https://www.googleapis.com/auth/admin.directory.domain"]},"delete":{"operationId":"directory.domainAliases.delete","x-executor-toolPath":"directory.domainAliases.delete","tags":["Admin SDK API"],"description":"Deletes a domain Alias of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"domainAliasName","in":"path","required":true,"description":"Name of domain alias to be retrieved.","schema":{"description":"Name of domain alias to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/domains":{"get":{"operationId":"directory.domains.list","x-executor-toolPath":"directory.domains.list","tags":["Admin SDK API"],"description":"Lists the domains of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains2"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain.readonly","https://www.googleapis.com/auth/admin.directory.domain"]},"post":{"operationId":"directory.domains.insert","x-executor-toolPath":"directory.domains.insert","tags":["Admin SDK API"],"description":"Inserts a domain of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/domains/{domainName}":{"get":{"operationId":"directory.domains.get","x-executor-toolPath":"directory.domains.get","tags":["Admin SDK API"],"description":"Retrieves a domain of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"domainName","in":"path","required":true,"description":"Name of domain to be retrieved","schema":{"description":"Name of domain to be retrieved","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain.readonly","https://www.googleapis.com/auth/admin.directory.domain"]},"delete":{"operationId":"directory.domains.delete","x-executor-toolPath":"directory.domains.delete","tags":["Admin SDK API"],"description":"Deletes a domain of the customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"domainName","in":"path","required":true,"description":"Name of domain to be deleted","schema":{"description":"Name of domain to be deleted","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.domain"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.domain"]}},"/admin/directory/v1/customer/{customer}/resources/buildings":{"get":{"operationId":"directory.resources.buildings.list","x-executor-toolPath":"directory.resources.buildings.list","tags":["Admin SDK API"],"description":"Retrieves a list of buildings for an account.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Buildings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly","https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"post":{"operationId":"directory.resources.buildings.insert","x-executor-toolPath":"directory.resources.buildings.insert","tags":["Admin SDK API"],"description":"Inserts a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"coordinatesSource","in":"query","required":false,"description":"Source from which Building.coordinates are derived.","schema":{"description":"Source from which Building.coordinates are derived.","default":"SOURCE_UNSPECIFIED","enum":["CLIENT_SPECIFIED","RESOLVED_FROM_ADDRESS","SOURCE_UNSPECIFIED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}":{"get":{"operationId":"directory.resources.buildings.get","x-executor-toolPath":"directory.resources.buildings.get","tags":["Admin SDK API"],"description":"Retrieves a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The unique ID of the building to retrieve.","schema":{"description":"The unique ID of the building to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly","https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"put":{"operationId":"directory.resources.buildings.update","x-executor-toolPath":"directory.resources.buildings.update","tags":["Admin SDK API"],"description":"Updates a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The id of the building to update.","schema":{"description":"The id of the building to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"coordinatesSource","in":"query","required":false,"description":"Source from which Building.coordinates are derived.","schema":{"description":"Source from which Building.coordinates are derived.","default":"SOURCE_UNSPECIFIED","enum":["CLIENT_SPECIFIED","RESOLVED_FROM_ADDRESS","SOURCE_UNSPECIFIED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"delete":{"operationId":"directory.resources.buildings.delete","x-executor-toolPath":"directory.resources.buildings.delete","tags":["Admin SDK API"],"description":"Deletes a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The id of the building to delete.","schema":{"description":"The id of the building to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"patch":{"operationId":"directory.resources.buildings.patch","x-executor-toolPath":"directory.resources.buildings.patch","tags":["Admin SDK API"],"description":"Patches a building.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"buildingId","in":"path","required":true,"description":"The id of the building to update.","schema":{"description":"The id of the building to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"coordinatesSource","in":"query","required":false,"description":"Source from which Building.coordinates are derived.","schema":{"description":"Source from which Building.coordinates are derived.","default":"SOURCE_UNSPECIFIED","enum":["CLIENT_SPECIFIED","RESOLVED_FROM_ADDRESS","SOURCE_UNSPECIFIED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Building"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/calendars":{"get":{"operationId":"directory.resources.calendars.list","x-executor-toolPath":"directory.resources.calendars.list","tags":["Admin SDK API"],"description":"Retrieves a list of calendar resources for an account.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form \"field [asc|desc], field [asc|desc], ...\". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order.","schema":{"description":"Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form \"field [asc|desc], field [asc|desc], ...\". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.","schema":{"description":"String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResources"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly","https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"post":{"operationId":"directory.resources.calendars.insert","x-executor-toolPath":"directory.resources.calendars.insert","tags":["Admin SDK API"],"description":"Inserts a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}":{"get":{"operationId":"directory.resources.calendars.get","x-executor-toolPath":"directory.resources.calendars.get","tags":["Admin SDK API"],"description":"Retrieves a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to retrieve.","schema":{"description":"The unique ID of the calendar resource to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly","https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"put":{"operationId":"directory.resources.calendars.update","x-executor-toolPath":"directory.resources.calendars.update","tags":["Admin SDK API"],"description":"Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to update.","schema":{"description":"The unique ID of the calendar resource to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"delete":{"operationId":"directory.resources.calendars.delete","x-executor-toolPath":"directory.resources.calendars.delete","tags":["Admin SDK API"],"description":"Deletes a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to delete.","schema":{"description":"The unique ID of the calendar resource to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"patch":{"operationId":"directory.resources.calendars.patch","x-executor-toolPath":"directory.resources.calendars.patch","tags":["Admin SDK API"],"description":"Patches a calendar resource.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"calendarResourceId","in":"path","required":true,"description":"The unique ID of the calendar resource to update.","schema":{"description":"The unique ID of the calendar resource to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/features":{"get":{"operationId":"directory.resources.features.list","x-executor-toolPath":"directory.resources.features.list","tags":["Admin SDK API"],"description":"Retrieves a list of features for an account.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Features"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly","https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"post":{"operationId":"directory.resources.features.insert","x-executor-toolPath":"directory.resources.features.insert","tags":["Admin SDK API"],"description":"Inserts a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/features/{featureKey}":{"get":{"operationId":"directory.resources.features.get","x-executor-toolPath":"directory.resources.features.get","tags":["Admin SDK API"],"description":"Retrieves a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to retrieve.","schema":{"description":"The unique ID of the feature to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly","https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"put":{"operationId":"directory.resources.features.update","x-executor-toolPath":"directory.resources.features.update","tags":["Admin SDK API"],"description":"Updates a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to update.","schema":{"description":"The unique ID of the feature to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"delete":{"operationId":"directory.resources.features.delete","x-executor-toolPath":"directory.resources.features.delete","tags":["Admin SDK API"],"description":"Deletes a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to delete.","schema":{"description":"The unique ID of the feature to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]},"patch":{"operationId":"directory.resources.features.patch","x-executor-toolPath":"directory.resources.features.patch","tags":["Admin SDK API"],"description":"Patches a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"featureKey","in":"path","required":true,"description":"The unique ID of the feature to update.","schema":{"description":"The unique ID of the feature to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename":{"post":{"operationId":"directory.resources.features.rename","x-executor-toolPath":"directory.resources.features.rename","tags":["Admin SDK API"],"description":"Renames a feature.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","schema":{"description":"The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.","type":"string"}},{"name":"oldName","in":"path","required":true,"description":"The unique ID of the feature to rename.","schema":{"description":"The unique ID of the feature to rename.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_FeatureRename"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.resource.calendar"]}},"/admin/directory/v1/customer/{customer}/roleassignments":{"get":{"operationId":"directory.roleAssignments.list","x-executor-toolPath":"directory.roleAssignments.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all roleAssignments.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeIndirectRoleAssignments","in":"query","required":false,"description":"When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `user_key` or the indirect role assignments will not be included.","schema":{"description":"When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `user_key` or the indirect role assignments will not be included.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"roleId","in":"query","required":false,"description":"Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.","schema":{"description":"Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userKey","in":"query","required":false,"description":"The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group.","schema":{"description":"The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignments"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly","https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"post":{"operationId":"directory.roleAssignments.insert","x-executor-toolPath":"directory.roleAssignments.insert","tags":["Admin SDK API"],"description":"Creates a role assignment.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}":{"get":{"operationId":"directory.roleAssignments.get","x-executor-toolPath":"directory.roleAssignments.get","tags":["Admin SDK API"],"description":"Retrieves a role assignment.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"roleAssignmentId","in":"path","required":true,"description":"Immutable ID of the role assignment.","schema":{"description":"Immutable ID of the role assignment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly","https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"delete":{"operationId":"directory.roleAssignments.delete","x-executor-toolPath":"directory.roleAssignments.delete","tags":["Admin SDK API"],"description":"Deletes a role assignment.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleAssignmentId","in":"path","required":true,"description":"Immutable ID of the role assignment.","schema":{"description":"Immutable ID of the role assignment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roles":{"get":{"operationId":"directory.roles.list","x-executor-toolPath":"directory.roles.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all the roles in a domain.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify the next page in the list.","schema":{"description":"Token to specify the next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Roles"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly","https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"post":{"operationId":"directory.roles.insert","x-executor-toolPath":"directory.roles.insert","tags":["Admin SDK API"],"description":"Creates a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roles/ALL/privileges":{"get":{"operationId":"directory.privileges.list","x-executor-toolPath":"directory.privileges.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all privileges for a customer.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Privileges"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly","https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customer/{customer}/roles/{roleId}":{"get":{"operationId":"directory.roles.get","x-executor-toolPath":"directory.roles.get","tags":["Admin SDK API"],"description":"Retrieves a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly","https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"put":{"operationId":"directory.roles.update","x-executor-toolPath":"directory.roles.update","tags":["Admin SDK API"],"description":"Updates a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"delete":{"operationId":"directory.roles.delete","x-executor-toolPath":"directory.roles.delete","tags":["Admin SDK API"],"description":"Deletes a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]},"patch":{"operationId":"directory.roles.patch","x-executor-toolPath":"directory.roles.patch","tags":["Admin SDK API"],"description":"Patches a role.","parameters":[{"name":"customer","in":"path","required":true,"description":"Immutable ID of the Google Workspace account.","schema":{"description":"Immutable ID of the Google Workspace account.","type":"string"}},{"name":"roleId","in":"path","required":true,"description":"Immutable ID of the role.","schema":{"description":"Immutable ID of the role.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Role"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.rolemanagement"]}},"/admin/directory/v1/customers/{customerKey}":{"get":{"operationId":"directory.customers.get","x-executor-toolPath":"directory.customers.get","tags":["Admin SDK API"],"description":"Retrieves a customer.","parameters":[{"name":"customerKey","in":"path","required":true,"description":"Id of the customer to be retrieved","schema":{"description":"Id of the customer to be retrieved","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.customer.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.customer"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.customer.readonly","https://www.googleapis.com/auth/admin.directory.customer"]},"put":{"operationId":"directory.customers.update","x-executor-toolPath":"directory.customers.update","tags":["Admin SDK API"],"description":"Updates a customer.","parameters":[{"name":"customerKey","in":"path","required":true,"description":"Id of the customer to be updated","schema":{"description":"Id of the customer to be updated","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.customer"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.customer"]},"patch":{"operationId":"directory.customers.patch","x-executor-toolPath":"directory.customers.patch","tags":["Admin SDK API"],"description":"Patches a customer.","parameters":[{"name":"customerKey","in":"path","required":true,"description":"Id of the customer to be updated","schema":{"description":"Id of the customer to be updated","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Customer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.customer"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.customer"]}},"/admin/directory/v1/customers/{customersId}/chrome/printServers/{printServersId}":{"get":{"operationId":"admin.customers.chrome.printServers.get","x-executor-toolPath":"admin.customers.chrome.printServers.get","tags":["Admin SDK API"],"description":"Returns a print server's configuration.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"printServersId","in":"path","required":true,"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers.readonly","https://www.googleapis.com/auth/admin.chrome.printers"]},"delete":{"operationId":"admin.customers.chrome.printServers.delete","x-executor-toolPath":"admin.customers.chrome.printServers.delete","tags":["Admin SDK API"],"description":"Deletes a print server.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"printServersId","in":"path","required":true,"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","schema":{"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"patch":{"operationId":"admin.customers.chrome.printServers.patch","x-executor-toolPath":"admin.customers.chrome.printServers.patch","tags":["Admin SDK API"],"description":"Updates a print server's configuration.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"printServersId","in":"path","required":true,"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","schema":{"description":"`printServersId` of `name` (`customers/{customersId}/chrome/printServers/{printServersId}`). Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"The list of fields to update. Some fields are read-only and cannot be updated. Values for unspecified fields are patched.","schema":{"description":"The list of fields to update. Some fields are read-only and cannot be updated. Values for unspecified fields are patched.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/customers/{customersId}/chrome/printers/{printersId}":{"get":{"operationId":"admin.customers.chrome.printers.get","x-executor-toolPath":"admin.customers.chrome.printers.get","tags":["Admin SDK API"],"description":"Returns a `Printer` resource (printer's config).","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"printersId","in":"path","required":true,"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to retrieve. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers.readonly","https://www.googleapis.com/auth/admin.chrome.printers"]},"delete":{"operationId":"admin.customers.chrome.printers.delete","x-executor-toolPath":"admin.customers.chrome.printers.delete","tags":["Admin SDK API"],"description":"Deletes a `Printer`.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"printersId","in":"path","required":true,"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","schema":{"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Required. The name of the printer to be updated. Format: customers/{customer_id}/chrome/printers/{printer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]},"patch":{"operationId":"admin.customers.chrome.printers.patch","x-executor-toolPath":"admin.customers.chrome.printers.patch","tags":["Admin SDK API"],"description":"Updates a `Printer` resource.","parameters":[{"name":"customersId","in":"path","required":true,"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","schema":{"description":"`customersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","type":"string"},"allowReserved":true},{"name":"printersId","in":"path","required":true,"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","schema":{"description":"`printersId` of `name` (`customers/{customersId}/chrome/printers/{printersId}`). Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"clearMask","in":"query","required":false,"description":"The list of fields to be cleared. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","schema":{"description":"The list of fields to be cleared. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"The list of fields to be updated. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","schema":{"description":"The list of fields to be updated. Note, some of the fields are read only and cannot be updated. Values for not specified fields will be patched.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/groups":{"get":{"operationId":"directory.groups.list","x-executor-toolPath":"directory.groups.list","tags":["Admin SDK API"],"description":"Retrieves all groups of a domain or of a user given a userKey (paginated).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customer","in":"query","required":false,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"},"style":"form","explode":false},{"name":"domain","in":"query","required":false,"description":"The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.","schema":{"description":"The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Max allowed value is 200.","schema":{"description":"Maximum number of results to return. Max allowed value is 200.","format":"int32","default":200,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Column to use for sorting results","schema":{"description":"Column to use for sorting results","enum":["email"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list","schema":{"description":"Token to specify next page in the list","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups).","schema":{"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order. Only of use when orderBy is also used","schema":{"description":"Whether to return results in ascending or descending order. Only of use when orderBy is also used","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userKey","in":"query","required":false,"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. Cannot be used with the `customer` parameter.","schema":{"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. Cannot be used with the `customer` parameter.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Groups"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.readonly","https://www.googleapis.com/auth/admin.directory.group"]},"post":{"operationId":"directory.groups.insert","x-executor-toolPath":"directory.groups.insert","tags":["Admin SDK API"],"description":"Creates a group.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}":{"get":{"operationId":"directory.groups.get","x-executor-toolPath":"directory.groups.get","tags":["Admin SDK API"],"description":"Retrieves a group's properties.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.readonly","https://www.googleapis.com/auth/admin.directory.group"]},"put":{"operationId":"directory.groups.update","x-executor-toolPath":"directory.groups.update","tags":["Admin SDK API"],"description":"Updates a group's properties.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"delete":{"operationId":"directory.groups.delete","x-executor-toolPath":"directory.groups.delete","tags":["Admin SDK API"],"description":"Deletes a group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]},"patch":{"operationId":"directory.groups.patch","x-executor-toolPath":"directory.groups.patch","tags":["Admin SDK API"],"description":"Updates a group's properties. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Group"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/aliases":{"get":{"operationId":"directory.groups.aliases.list","x-executor-toolPath":"directory.groups.aliases.list","tags":["Admin SDK API"],"description":"Lists all aliases for a group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Aliases"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.readonly","https://www.googleapis.com/auth/admin.directory.group"]},"post":{"operationId":"directory.groups.aliases.insert","x-executor-toolPath":"directory.groups.aliases.insert","tags":["Admin SDK API"],"description":"Adds an alias for the group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/aliases/{alias}":{"delete":{"operationId":"directory.groups.aliases.delete","x-executor-toolPath":"directory.groups.aliases.delete","tags":["Admin SDK API"],"description":"Removes an alias.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"alias","in":"path","required":true,"description":"The alias to be removed","schema":{"description":"The alias to be removed","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}":{"get":{"operationId":"directory.members.hasMember","x-executor-toolPath":"directory.members.hasMember","tags":["Admin SDK API"],"description":"Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group's domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.","schema":{"description":"Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_MembersHasMember"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.member","https://www.googleapis.com/auth/admin.directory.group.member.readonly","https://www.googleapis.com/auth/admin.directory.group.readonly","https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/members":{"get":{"operationId":"directory.members.list","x-executor-toolPath":"directory.members.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDerivedMembership","in":"query","required":false,"description":"Whether to list indirect memberships. Default: false.","schema":{"description":"Whether to list indirect memberships. Default: false.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return. Max allowed value is 200.","schema":{"description":"Maximum number of results to return. Max allowed value is 200.","format":"int32","default":200,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list.","schema":{"description":"Token to specify next page in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"roles","in":"query","required":false,"description":"The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.","schema":{"description":"The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Members"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.member","https://www.googleapis.com/auth/admin.directory.group.member.readonly","https://www.googleapis.com/auth/admin.directory.group.readonly","https://www.googleapis.com/auth/admin.directory.group"]},"post":{"operationId":"directory.members.insert","x-executor-toolPath":"directory.members.insert","tags":["Admin SDK API"],"description":"Adds a user to the specified group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.member","https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/groups/{groupKey}/members/{memberKey}":{"get":{"operationId":"directory.members.get","x-executor-toolPath":"directory.members.get","tags":["Admin SDK API"],"description":"Retrieves a group member's properties.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.member","https://www.googleapis.com/auth/admin.directory.group.member.readonly","https://www.googleapis.com/auth/admin.directory.group.readonly","https://www.googleapis.com/auth/admin.directory.group"]},"put":{"operationId":"directory.members.update","x-executor-toolPath":"directory.members.update","tags":["Admin SDK API"],"description":"Updates the membership of a user in the specified group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.member","https://www.googleapis.com/auth/admin.directory.group"]},"delete":{"operationId":"directory.members.delete","x-executor-toolPath":"directory.members.delete","tags":["Admin SDK API"],"description":"Removes a member from a group.","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.member","https://www.googleapis.com/auth/admin.directory.group"]},"patch":{"operationId":"directory.members.patch","x-executor-toolPath":"directory.members.patch","tags":["Admin SDK API"],"description":"Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"groupKey","in":"path","required":true,"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","schema":{"description":"Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.","type":"string"}},{"name":"memberKey","in":"path","required":true,"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","schema":{"description":"Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group.member"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.group"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.group.member","https://www.googleapis.com/auth/admin.directory.group"]}},"/admin/directory/v1/users":{"get":{"operationId":"directory.users.list","x-executor-toolPath":"directory.users.list","tags":["Admin SDK API"],"description":"Retrieves a paginated list of either deleted users or all users in a domain.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customFieldMask","in":"query","required":false,"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","schema":{"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","type":"string"},"style":"form","explode":false},{"name":"customer","in":"query","required":false,"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","schema":{"description":"The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.","type":"string"},"style":"form","explode":false},{"name":"domain","in":"query","required":false,"description":"The domain name. Use this field to get users from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.","schema":{"description":"The domain name. Use this field to get users from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Event on which subscription is intended (if subscribing)","schema":{"description":"Event on which subscription is intended (if subscribing)","enum":["add","delete","makeAdmin","undelete","update"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Property to use for sorting results.","schema":{"description":"Property to use for sorting results.","enum":["email","familyName","givenName"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list. The page token is only valid for three days.","schema":{"description":"Token to specify next page in the list. The page token is only valid for three days.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"What subset of fields to fetch for this user.","schema":{"description":"What subset of fields to fetch for this user.","default":"basic","enum":["basic","custom","full"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","schema":{"description":"Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"If set to `true`, retrieves the list of deleted users. (Default: `false`)","schema":{"description":"If set to `true`, retrieves the list of deleted users. (Default: `false`)","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order, ignoring case.","schema":{"description":"Whether to return results in ascending or descending order, ignoring case.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"viewType","in":"query","required":false,"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","schema":{"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","default":"admin_view","enum":["admin_view","domain_public"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Users"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.readonly","https://www.googleapis.com/auth/admin.directory.user"]},"post":{"operationId":"directory.users.insert","x-executor-toolPath":"directory.users.insert","tags":["Admin SDK API"],"description":"Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolve_conflict_account` is set to `true`, the option selected for [Find and add unmanaged users](https://knowledge.workspace.google.com/admin/users/find-and-add-unmanaged-users) will apply to resolve conflicting accounts: - A `200` response code indicates the user was created (or replaced an existing unmanaged personal account). - A `202` response code means that a conflicting unmanaged personal account exists and was invited to join the organization. - A `409` response code means that a conflicting account exists so the user wasn't created (e.g. based on the option selected to preserve the account, or if the email conflicts with an unmanaged work account or existing managed user). For details on resolving duplicate account errors, see [Resolve duplicate account errors](https://knowledge.workspace.google.com/p/duplicate-account-errors) and [Transfer unmanaged work accounts](https://knowledge.workspace.google.com/p/unmanaged-work-accounts).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"resolveConflictAccount","in":"query","required":false,"description":"Optional. Applies the option selected for [Find and add unmanaged users](https://knowledge.workspace.google.com/admin/users/find-and-add-unmanaged-users) to resolve conflicting accounts when set to `true`. Default: `false`","schema":{"description":"Optional. Applies the option selected for [Find and add unmanaged users](https://knowledge.workspace.google.com/admin/users/find-and-add-unmanaged-users) to resolve conflicting accounts when set to `true`. Default: `false`","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/watch":{"post":{"operationId":"directory.users.watch","x-executor-toolPath":"directory.users.watch","tags":["Admin SDK API"],"description":"Watches for changes in users list.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customFieldMask","in":"query","required":false,"description":"Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.","schema":{"description":"Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.","type":"string"},"style":"form","explode":false},{"name":"customer","in":"query","required":false,"description":"Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.","schema":{"description":"Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.","type":"string"},"style":"form","explode":false},{"name":"domain","in":"query","required":false,"description":"Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.\"","schema":{"description":"Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.\"","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Events to watch for.","schema":{"description":"Events to watch for.","enum":["add","delete","makeAdmin","undelete","update"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"description":"Maximum number of results to return.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Column to use for sorting results","schema":{"description":"Column to use for sorting results","enum":["email","familyName","givenName"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token to specify next page in the list","schema":{"description":"Token to specify next page in the list","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"What subset of fields to fetch for this user.","schema":{"description":"What subset of fields to fetch for this user.","default":"basic","enum":["basic","custom","full"],"type":"string"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","schema":{"description":"Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"If set to true, retrieves the list of deleted users. (Default: false)","schema":{"description":"If set to true, retrieves the list of deleted users. (Default: false)","type":"string"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Whether to return results in ascending or descending order.","schema":{"description":"Whether to return results in ascending or descending order.","enum":["ASCENDING","DESCENDING"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"viewType","in":"query","required":false,"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","schema":{"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","default":"admin_view","enum":["admin_view","domain_public"],"type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.readonly","https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}":{"get":{"operationId":"directory.users.get","x-executor-toolPath":"directory.users.get","tags":["Admin SDK API"],"description":"Retrieves a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customFieldMask","in":"query","required":false,"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","schema":{"description":"A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"What subset of fields to fetch for this user.","schema":{"description":"What subset of fields to fetch for this user.","default":"basic","enum":["basic","custom","full"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"viewType","in":"query","required":false,"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","schema":{"description":"Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).","default":"admin_view","enum":["admin_view","domain_public"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.readonly","https://www.googleapis.com/auth/admin.directory.user"]},"put":{"operationId":"directory.users.update","x-executor-toolPath":"directory.users.update","tags":["Admin SDK API"],"description":"Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"delete":{"operationId":"directory.users.delete","x-executor-toolPath":"directory.users.delete","tags":["Admin SDK API"],"description":"Deletes a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"patch":{"operationId":"directory.users.patch","x-executor-toolPath":"directory.users.patch","tags":["Admin SDK API"],"description":"Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/aliases":{"get":{"operationId":"directory.users.aliases.list","x-executor-toolPath":"directory.users.aliases.list","tags":["Admin SDK API"],"description":"Lists all aliases for a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Events to watch for.","schema":{"description":"Events to watch for.","enum":["add","delete"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Aliases"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["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"]},"post":{"operationId":"directory.users.aliases.insert","x-executor-toolPath":"directory.users.aliases.insert","tags":["Admin SDK API"],"description":"Adds an alias.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Alias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.alias","https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/aliases/watch":{"post":{"operationId":"directory.users.aliases.watch","x-executor-toolPath":"directory.users.aliases.watch","tags":["Admin SDK API"],"description":"Watches for changes in users list.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Email or immutable ID of the user","schema":{"description":"Email or immutable ID of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"event","in":"query","required":false,"description":"Events to watch for.","schema":{"description":"Events to watch for.","enum":["add","delete"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["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"]}},"/admin/directory/v1/users/{userKey}/aliases/{alias}":{"delete":{"operationId":"directory.users.aliases.delete","x-executor-toolPath":"directory.users.aliases.delete","tags":["Admin SDK API"],"description":"Removes an alias.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"alias","in":"path","required":true,"description":"The alias to be removed.","schema":{"description":"The alias to be removed.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.alias","https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/asps":{"get":{"operationId":"directory.asps.list","x-executor-toolPath":"directory.asps.list","tags":["Admin SDK API"],"description":"Lists the ASPs issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Asps"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/asps/{codeId}":{"get":{"operationId":"directory.asps.get","x-executor-toolPath":"directory.asps.get","tags":["Admin SDK API"],"description":"Gets information about an ASP issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"codeId","in":"path","required":true,"description":"The unique ID of the ASP.","schema":{"description":"The unique ID of the ASP.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Asp"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]},"delete":{"operationId":"directory.asps.delete","x-executor-toolPath":"directory.asps.delete","tags":["Admin SDK API"],"description":"Deletes an ASP issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"codeId","in":"path","required":true,"description":"The unique ID of the ASP to be deleted.","schema":{"description":"The unique ID of the ASP to be deleted.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/makeAdmin":{"post":{"operationId":"directory.users.makeAdmin","x-executor-toolPath":"directory.users.makeAdmin","tags":["Admin SDK API"],"description":"Makes a user a super administrator.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserMakeAdmin"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/photos/thumbnail":{"get":{"operationId":"directory.users.photos.get","x-executor-toolPath":"directory.users.photos.get","tags":["Admin SDK API"],"description":"Retrieves the user's photo.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.readonly","https://www.googleapis.com/auth/admin.directory.user"]},"put":{"operationId":"directory.users.photos.update","x-executor-toolPath":"directory.users.photos.update","tags":["Admin SDK API"],"description":"Adds a photo for the user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"delete":{"operationId":"directory.users.photos.delete","x-executor-toolPath":"directory.users.photos.delete","tags":["Admin SDK API"],"description":"Removes the user's photo.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]},"patch":{"operationId":"directory.users.photos.patch","x-executor-toolPath":"directory.users.photos.patch","tags":["Admin SDK API"],"description":"Adds a photo for the user. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserPhoto"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/signOut":{"post":{"operationId":"directory.users.signOut","x-executor-toolPath":"directory.users.signOut","tags":["Admin SDK API"],"description":"Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/tokens":{"get":{"operationId":"directory.tokens.list","x-executor-toolPath":"directory.tokens.list","tags":["Admin SDK API"],"description":"Returns the set of tokens specified user has issued to 3rd party applications.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Tokens"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/tokens/{clientId}":{"get":{"operationId":"directory.tokens.get","x-executor-toolPath":"directory.tokens.get","tags":["Admin SDK API"],"description":"Gets information about an access token issued by a user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"clientId","in":"path","required":true,"description":"The Client ID of the application the token is issued to.","schema":{"description":"The Client ID of the application the token is issued to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Token"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]},"delete":{"operationId":"directory.tokens.delete","x-executor-toolPath":"directory.tokens.delete","tags":["Admin SDK API"],"description":"Deletes all access tokens issued by a user for an application.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"clientId","in":"path","required":true,"description":"The Client ID of the application the token is issued to.","schema":{"description":"The Client ID of the application the token is issued to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/twoStepVerification/turnOff":{"post":{"operationId":"directory.twoStepVerification.turnOff","x-executor-toolPath":"directory.twoStepVerification.turnOff","tags":["Admin SDK API"],"description":"Turns off 2-Step Verification for user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/undelete":{"post":{"operationId":"directory.users.undelete","x-executor-toolPath":"directory.users.undelete","tags":["Admin SDK API"],"description":"Undeletes a deleted user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"The immutable id of the user","schema":{"description":"The immutable id of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_UserUndelete"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/users/{userKey}/verificationCodes":{"get":{"operationId":"directory.verificationCodes.list","x-executor-toolPath":"directory.verificationCodes.list","tags":["Admin SDK API"],"description":"Returns the current set of valid backup verification codes for the specified user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","schema":{"description":"Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_VerificationCodes"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/verificationCodes/generate":{"post":{"operationId":"directory.verificationCodes.generate","x-executor-toolPath":"directory.verificationCodes.generate","tags":["Admin SDK API"],"description":"Generates new backup verification codes for the user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Email or immutable ID of the user","schema":{"description":"Email or immutable ID of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users/{userKey}/verificationCodes/invalidate":{"post":{"operationId":"directory.verificationCodes.invalidate","x-executor-toolPath":"directory.verificationCodes.invalidate","tags":["Admin SDK API"],"description":"Invalidates the current backup verification codes for the user.","parameters":[{"name":"userKey","in":"path","required":true,"description":"Email or immutable ID of the user","schema":{"description":"Email or immutable ID of the user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.security"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user.security"]}},"/admin/directory/v1/users:createGuest":{"post":{"operationId":"directory.users.createGuest","x-executor-toolPath":"directory.users.createGuest","tags":["Admin SDK API"],"description":"Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Open Beta.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryUsersCreateGuestRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.directory.user"]}},"/admin/directory/v1/{parent}/chrome/printServers":{"get":{"operationId":"admin.customers.chrome.printServers.list","x-executor-toolPath":"admin.customers.chrome.printServers.list","tags":["Admin SDK API"],"description":"Lists print server configurations.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`.","schema":{"description":"Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending \"desc\" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order.","schema":{"description":"Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending \"desc\" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order.","type":"string"},"style":"form","explode":false},{"name":"orgUnitId","in":"query","required":false,"description":"If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against.","schema":{"description":"If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of objects to return (default `100`, max `100`). The service might return fewer than this value.","schema":{"description":"The maximum number of objects to return (default `100`, max `100`). The service might return fewer than this value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A generated token to paginate results (the `next_page_token` from a previous call).","schema":{"description":"A generated token to paginate results (the `next_page_token` from a previous call).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ListPrintServersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers.readonly","https://www.googleapis.com/auth/admin.chrome.printers"]},"post":{"operationId":"admin.customers.chrome.printServers.create","x-executor-toolPath":"admin.customers.chrome.printServers.create","tags":["Admin SDK API"],"description":"Creates a print server.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printServers:batchCreatePrintServers":{"post":{"operationId":"admin.customers.chrome.printServers.batchCreatePrintServers","x-executor-toolPath":"admin.customers.chrome.printServers.batchCreatePrintServers","tags":["Admin SDK API"],"description":"Creates multiple print servers.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintServersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintServersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printServers:batchDeletePrintServers":{"post":{"operationId":"admin.customers.chrome.printServers.batchDeletePrintServers","x-executor-toolPath":"admin.customers.chrome.printServers.batchDeletePrintServers","tags":["Admin SDK API"],"description":"Deletes multiple print servers.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}`","schema":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintServersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintServersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers":{"get":{"operationId":"admin.customers.chrome.printers.list","x-executor-toolPath":"admin.customers.chrome.printers.list","tags":["Admin SDK API"],"description":"List printers configs.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Search query. Search syntax is shared between this api and Admin Console printers pages.","schema":{"description":"Search query. Search syntax is shared between this api and Admin Console printers pages.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"The order to sort results by. Must be one of display_name, description, make_and_model, or create_time. Default order is ascending, but descending order can be returned by appending \"desc\" to the order_by field. For instance, \"description desc\" will return the printers sorted by description in descending order.","schema":{"description":"The order to sort results by. Must be one of display_name, description, make_and_model, or create_time. Default order is ascending, but descending order can be returned by appending \"desc\" to the order_by field. For instance, \"description desc\" will return the printers sorted by description in descending order.","type":"string"},"style":"form","explode":false},{"name":"orgUnitId","in":"query","required":false,"description":"Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id.","schema":{"description":"Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of objects to return. The service may return fewer than this value.","schema":{"description":"The maximum number of objects to return. The service may return fewer than this value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A page token, received from a previous call.","schema":{"description":"A page token, received from a previous call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ListPrintersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers.readonly","https://www.googleapis.com/auth/admin.chrome.printers"]},"post":{"operationId":"admin.customers.chrome.printers.create","x-executor-toolPath":"admin.customers.chrome.printers.create","tags":["Admin SDK API"],"description":"Creates a printer under given Organization Unit.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers:batchCreatePrinters":{"post":{"operationId":"admin.customers.chrome.printers.batchCreatePrinters","x-executor-toolPath":"admin.customers.chrome.printers.batchCreatePrinters","tags":["Admin SDK API"],"description":"Creates printers under given Organization Unit.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchCreatePrintersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers:batchDeletePrinters":{"post":{"operationId":"admin.customers.chrome.printers.batchDeletePrinters","x-executor-toolPath":"admin.customers.chrome.printers.batchDeletePrinters","tags":["Admin SDK API"],"description":"Deletes printers in batch.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_BatchDeletePrintersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory/v1/{parent}/chrome/printers:listPrinterModels":{"get":{"operationId":"admin.customers.chrome.printers.listPrinterModels","x-executor-toolPath":"admin.customers.chrome.printers.listPrinterModels","tags":["Admin SDK API"],"description":"Lists the supported printer models.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","schema":{"description":"Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Filer to list only models by a given manufacturer in format: \"manufacturer:Brother\". Search syntax is shared between this api and Admin Console printers pages.","schema":{"description":"Filer to list only models by a given manufacturer in format: \"manufacturer:Brother\". Search syntax is shared between this api and Admin Console printers pages.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of objects to return. The service may return fewer than this value.","schema":{"description":"The maximum number of objects to return. The service may return fewer than this value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A page token, received from a previous call.","schema":{"description":"A page token, received from a previous call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_ListPrinterModelsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.chrome.printers"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.chrome.printers.readonly","https://www.googleapis.com/auth/admin.chrome.printers"]}},"/admin/directory_v1/channels/stop":{"post":{"operationId":"admin.channels.stop","x-executor-toolPath":"admin.channels.stop","tags":["Admin SDK API"],"description":"Stops watching resources through this channel.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_directory_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.alias.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/admin.directory.user"]}],"x-google-scopes":["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"]}}},"components":{"schemas":{"admin_directory_v1_Alias":{"description":"JSON template for Alias object in Directory API.","type":"object","properties":{"alias":{"type":"string"},"etag":{"type":"string"},"id":{"type":"string"},"kind":{"default":"admin#directory#alias","type":"string"},"primaryEmail":{"type":"string"}}},"admin_directory_v1_Aliases":{"description":"JSON response template to list aliases in Directory API.","type":"object","properties":{"aliases":{"type":"array","items":{}},"etag":{"type":"string"},"kind":{"default":"admin#directory#aliases","type":"string"}}},"admin_directory_v1_Asp":{"description":"An application-specific password (ASP) is used with applications that do not accept a verification code when logging into the application on certain devices. The ASP access code is used instead of the login and password you commonly use when accessing an application through a browser. For more information about ASPs and how to create one, see the [help center](https://support.google.com/a/answer/2537800#asp).","type":"object","properties":{"codeId":{"description":"The unique ID of the ASP.","format":"int32","type":"integer"},"creationTime":{"description":"The time when the ASP was created. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format.","format":"int64","type":"string"},"etag":{"description":"ETag of the ASP.","type":"string"},"kind":{"description":"The type of the API resource. This is always `admin#directory#asp`.","default":"admin#directory#asp","type":"string"},"lastTimeUsed":{"description":"The time when the ASP was last used. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format.","format":"int64","type":"string"},"name":{"description":"The name of the application that the user, represented by their `userId`, entered when the ASP was created.","type":"string"},"userKey":{"description":"The unique ID of the user who issued the ASP.","type":"string"}}},"admin_directory_v1_Asps":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of ASP resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Asp"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#aspList`.","default":"admin#directory#aspList","type":"string"}}},"admin_directory_v1_AuxiliaryMessage":{"description":"Auxiliary message about issues with printers or settings. Example: {message_type:AUXILIARY_MESSAGE_WARNING, field_mask:make_and_model, message:\"Given printer is invalid or no longer supported.\"}","type":"object","properties":{"auxiliaryMessage":{"description":"Human readable message in English. Example: \"Given printer is invalid or no longer supported.\"","type":"string"},"fieldMask":{"description":"Field that this message concerns.","format":"google-fieldmask","type":"string"},"severity":{"description":"Message severity","enum":["SEVERITY_UNSPECIFIED","SEVERITY_INFO","SEVERITY_WARNING","SEVERITY_ERROR"],"type":"string"}}},"admin_directory_v1_BacklightInfo":{"description":"Information about the device's backlights.","type":"object","properties":{"brightness":{"description":"Output only. Current brightness of the backlight, between 0 and max_brightness.","format":"int32","readOnly":true,"type":"integer"},"maxBrightness":{"description":"Output only. Maximum brightness for the backlight.","format":"int32","readOnly":true,"type":"integer"},"path":{"description":"Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information.","readOnly":true,"type":"string"}}},"admin_directory_v1_BatchChangeChromeOsDeviceStatusRequest":{"description":"A request for changing the status of a batch of ChromeOS devices.","type":"object","properties":{"changeChromeOsDeviceStatusAction":{"description":"Required. The action to take on the ChromeOS device in order to change its status.","enum":["CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED","CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION","CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE","CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE"],"type":"string"},"deprovisionReason":{"description":"Optional. The reason behind a device deprovision. Must be provided if 'changeChromeOsDeviceStatusAction' is set to 'CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION'. Otherwise, omit this field.","enum":["DEPROVISION_REASON_UNSPECIFIED","DEPROVISION_REASON_SAME_MODEL_REPLACEMENT","DEPROVISION_REASON_UPGRADE","DEPROVISION_REASON_DOMAIN_MOVE","DEPROVISION_REASON_SERVICE_EXPIRATION","DEPROVISION_REASON_OTHER","DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT","DEPROVISION_REASON_RETIRING_DEVICE","DEPROVISION_REASON_UPGRADE_TRANSFER","DEPROVISION_REASON_NOT_REQUIRED","DEPROVISION_REASON_REPAIR_CENTER"],"type":"string"},"deviceIds":{"description":"Required. List of the IDs of the ChromeOS devices to change. Maximum 50.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchChangeChromeOsDeviceStatusResponse":{"description":"The response of changing the status of a batch of ChromeOS devices.","type":"object","properties":{"changeChromeOsDeviceStatusResults":{"description":"The results for each of the ChromeOS devices provided in the request.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_ChangeChromeOsDeviceStatusResult"}}}},"admin_directory_v1_BatchCreatePrintServersRequest":{"description":"Request to add multiple new print servers in a batch.","type":"object","properties":{"requests":{"description":"Required. A list of `PrintServer` resources to be created (max `50` per batch).","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_CreatePrintServerRequest"}}}},"admin_directory_v1_BatchCreatePrintServersResponse":{"type":"object","properties":{"failures":{"description":"A list of create failures. `PrintServer` IDs are not populated, as print servers were not created.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServerFailureInfo"}},"printServers":{"description":"A list of successfully created print servers with their IDs populated.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"admin_directory_v1_BatchCreatePrintersRequest":{"description":"Request for adding new printers in batch.","type":"object","properties":{"requests":{"description":"A list of Printers to be created. Max 50 at a time.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_CreatePrinterRequest"}}}},"admin_directory_v1_BatchCreatePrintersResponse":{"description":"Response for adding new printers in batch.","type":"object","properties":{"failures":{"description":"A list of create failures. Printer IDs are not populated, as printer were not created.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_FailureInfo"}},"printers":{"description":"A list of successfully created printers with their IDs populated.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"admin_directory_v1_BatchDeletePrintServersRequest":{"description":"Request to delete multiple existing print servers in a batch.","type":"object","properties":{"printServerIds":{"description":"A list of print server IDs that should be deleted (max `100` per batch).","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchDeletePrintServersResponse":{"type":"object","properties":{"failedPrintServers":{"description":"A list of update failures.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServerFailureInfo"}},"printServerIds":{"description":"A list of print server IDs that were successfully deleted.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchDeletePrintersRequest":{"description":"Request for deleting existing printers in batch.","type":"object","properties":{"printerIds":{"description":"A list of Printer.id that should be deleted. Max 100 at a time.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BatchDeletePrintersResponse":{"description":"Response for deleting existing printers in batch.","type":"object","properties":{"failedPrinters":{"description":"A list of update failures.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_FailureInfo"}},"printerIds":{"description":"A list of Printer.id that were successfully deleted.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_BluetoothAdapterInfo":{"description":"Information about a device's Bluetooth adapter.","type":"object","properties":{"address":{"description":"Output only. The MAC address of the adapter.","readOnly":true,"type":"string"},"numConnectedDevices":{"description":"Output only. The number of devices connected to this adapter.","format":"int32","readOnly":true,"type":"integer"}}},"admin_directory_v1_Building":{"description":"Public API: Resources.buildings","type":"object","properties":{"address":{"$ref":"#/components/schemas/admin_directory_v1_BuildingAddress"},"buildingId":{"description":"Unique identifier for the building. The maximum length is 100 characters.","type":"string"},"buildingName":{"description":"The building name as seen by users in Calendar. Must be unique for the customer. For example, \"NYC-CHEL\". The maximum length is 100 characters.","type":"string"},"coordinates":{"$ref":"#/components/schemas/admin_directory_v1_BuildingCoordinates"},"description":{"description":"A brief description of the building. For example, \"Chelsea Market\".","type":"string"},"etags":{"description":"ETag of the resource.","type":"string"},"floorNames":{"description":"The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, [\"B2\", \"B1\", \"L\", \"1\", \"2\", \"2M\", \"3\", \"PH\"] Must contain at least one entry.","type":"array","items":{"type":"string"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#buildings#Building","type":"string"}}},"admin_directory_v1_BuildingAddress":{"description":"Public API: Resources.buildings","type":"object","properties":{"addressLines":{"description":"Unstructured address lines describing the lower levels of an address.","type":"array","items":{"type":"string"}},"administrativeArea":{"description":"Optional. Highest administrative subdivision which is used for postal addresses of a country or region.","type":"string"},"languageCode":{"description":"Optional. BCP-47 language code of the contents of this address (if known).","type":"string"},"locality":{"description":"Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.","type":"string"},"postalCode":{"description":"Optional. Postal code of the address.","type":"string"},"regionCode":{"description":"Required. CLDR region code of the country/region of the address.","type":"string"},"sublocality":{"description":"Optional. Sublocality of the address.","type":"string"}}},"admin_directory_v1_BuildingCoordinates":{"description":"Public API: Resources.buildings","type":"object","properties":{"latitude":{"description":"Latitude in decimal degrees.","format":"double","type":"number"},"longitude":{"description":"Longitude in decimal degrees.","format":"double","type":"number"}}},"admin_directory_v1_Buildings":{"description":"Public API: Resources.buildings","type":"object","properties":{"buildings":{"description":"The Buildings in this page of results.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Building"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#buildings#buildingsList","type":"string"},"nextPageToken":{"description":"The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.","type":"string"}}},"admin_directory_v1_ByteUsage":{"description":"Represents a data capacity with some amount of current usage in bytes.","type":"object","properties":{"capacityBytes":{"description":"Output only. The total capacity value, in bytes.","format":"int64","readOnly":true,"type":"string"},"usedBytes":{"description":"Output only. The current usage value, in bytes.","format":"int64","readOnly":true,"type":"string"}}},"admin_directory_v1_CalendarResource":{"description":"Public API: Resources.calendars","type":"object","properties":{"buildingId":{"description":"Unique ID for the building a resource is located in.","type":"string"},"capacity":{"description":"Capacity of a resource, number of seats in a room.","format":"int32","type":"integer"},"etags":{"description":"ETag of the resource.","type":"string"},"featureInstances":{"description":"Instances of features for the calendar resource."},"floorName":{"description":"Name of the floor a resource is located on.","type":"string"},"floorSection":{"description":"Name of the section within a floor a resource is located in.","type":"string"},"generatedResourceName":{"description":"The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, \"NYC-2-Training Room 1A (16)\".","type":"string"},"kind":{"description":"The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`.","default":"admin#directory#resources#calendars#CalendarResource","type":"string"},"resourceCategory":{"description":"The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.","type":"string"},"resourceDescription":{"description":"Description of the resource, visible only to admins.","type":"string"},"resourceEmail":{"description":"The read-only email for the calendar resource. Generated as part of creating a new calendar resource.","type":"string"},"resourceId":{"description":"The unique ID for the calendar resource.","type":"string"},"resourceName":{"description":"The name of the calendar resource. For example, \"Training Room 1A\".","type":"string"},"resourceType":{"description":"The type of the calendar resource, intended for non-room resources.","type":"string"},"userVisibleDescription":{"description":"Description of the resource, visible to users and admins.","type":"string"}}},"admin_directory_v1_CalendarResources":{"description":"Public API: Resources.calendars","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"The CalendarResources in this page of results.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_CalendarResource"}},"kind":{"description":"Identifies this as a collection of CalendarResources. This is always `admin#directory#resources#calendars#calendarResourcesList`.","default":"admin#directory#resources#calendars#calendarResourcesList","type":"string"},"nextPageToken":{"description":"The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.","type":"string"}}},"admin_directory_v1_ChangeChromeOsDeviceStatusResult":{"description":"The result of a single ChromeOS device for a Change state operation.","type":"object","properties":{"deviceId":{"description":"The unique ID of the ChromeOS device.","type":"string"},"error":{"$ref":"#/components/schemas/admin_directory_v1_Status"},"response":{"$ref":"#/components/schemas/admin_directory_v1_ChangeChromeOsDeviceStatusSucceeded"}}},"admin_directory_v1_ChangeChromeOsDeviceStatusSucceeded":{"description":"Response for a successful ChromeOS device status change.","type":"object"},"admin_directory_v1_Channel":{"description":"An notification channel used to watch for resource changes.","type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional. For example, `params.ttl` specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days.","type":"object","additionalProperties":{"type":"string"}},"payload":{"description":"A Boolean value to indicate whether payload is wanted. Optional.","type":"boolean"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel.","type":"string"}}},"admin_directory_v1_ChromeOsDevice":{"description":"Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices).","type":"object","properties":{"activeTimeRanges":{"description":"A list of active time ranges (Read-only).","type":"array","items":{"type":"object","properties":{"activeTime":{"description":"Duration of usage in milliseconds.","format":"int32","type":"integer"},"date":{"description":"Date of usage","format":"date","type":"string"}}}},"annotatedAssetId":{"description":"The asset identifier as noted by an administrator or specified during enrollment.","type":"string"},"annotatedLocation":{"description":"The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.","type":"string"},"annotatedUser":{"description":"The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.","type":"string"},"autoUpdateExpiration":{"description":"(Read-only) The timestamp after which the device will stop receiving Chrome updates or support. Please use \"autoUpdateThrough\" instead.","format":"int64","type":"string"},"autoUpdateThrough":{"description":"Output only. The timestamp after which the device will stop receiving Chrome updates or support.","readOnly":true,"type":"string"},"backlightInfo":{"description":"Output only. Contains backlight information for the device.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_BacklightInfo"}},"bluetoothAdapterInfo":{"description":"Output only. Information about Bluetooth adapters of the device.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_BluetoothAdapterInfo"}},"bootMode":{"description":"The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).","type":"string"},"chromeOsType":{"description":"Output only. Chrome OS type of the device.","readOnly":true,"enum":["chromeOsTypeUnspecified","chromeOsFlex","chromeOs"],"type":"string"},"cpuInfo":{"description":"Information regarding CPU specs in the device.","type":"array","items":{"description":"CPU specs for a CPU.","type":"object","properties":{"architecture":{"description":"The CPU architecture.","type":"string"},"logicalCpus":{"description":"Information for the Logical CPUs","type":"array","items":{"description":"Status of a single logical CPU.","type":"object","properties":{"cStates":{"description":"C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.","type":"array","items":{"description":"Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.","type":"object","properties":{"displayName":{"description":"Name of the state.","type":"string"},"sessionDuration":{"description":"Time spent in the state since the last reboot.","format":"google-duration","type":"string"}}}},"currentScalingFrequencyKhz":{"description":"Current frequency the CPU is running at.","format":"int32","type":"integer"},"idleDuration":{"description":"Idle time since last boot.","format":"google-duration","type":"string"},"maxScalingFrequencyKhz":{"description":"Maximum frequency the CPU is allowed to run at, by policy.","format":"int32","type":"integer"}}}},"maxClockSpeedKhz":{"description":"The max CPU clock speed in kHz.","format":"int32","type":"integer"},"model":{"description":"The CPU model name.","type":"string"}}}},"cpuStatusReports":{"description":"Reports of CPU utilization and temperature (Read-only)","type":"array","items":{"type":"object","properties":{"cpuTemperatureInfo":{"description":"A list of CPU temperature samples.","type":"array","items":{"type":"object","properties":{"label":{"description":"CPU label","type":"string"},"temperature":{"description":"Temperature in Celsius degrees.","format":"int32","type":"integer"}}}},"cpuUtilizationPercentageInfo":{"type":"array","items":{"format":"int32","type":"integer"}},"reportTime":{"description":"Date and time the report was received.","format":"date-time","type":"string"}}}},"deprovisionReason":{"description":"(Read-only) Deprovision reason.","enum":["DEPROVISION_REASON_UNSPECIFIED","DEPROVISION_REASON_SAME_MODEL_REPLACEMENT","DEPROVISION_REASON_UPGRADE","DEPROVISION_REASON_DOMAIN_MOVE","DEPROVISION_REASON_SERVICE_EXPIRATION","DEPROVISION_REASON_OTHER","DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT","DEPROVISION_REASON_RETIRING_DEVICE","DEPROVISION_REASON_UPGRADE_TRANSFER","DEPROVISION_REASON_NOT_REQUIRED","DEPROVISION_REASON_REPAIR_CENTER"],"type":"string"},"deviceFiles":{"description":"A list of device files to download (Read-only)","type":"array","items":{"type":"object","properties":{"createTime":{"description":"Date and time the file was created","format":"date-time","type":"string"},"downloadUrl":{"description":"File download URL","type":"string"},"name":{"description":"File name","type":"string"},"type":{"description":"File type","type":"string"}}}},"deviceId":{"description":"The unique ID of the Chrome device.","type":"string"},"deviceLicenseType":{"description":"Output only. Device license type.","readOnly":true,"enum":["deviceLicenseTypeUnspecified","enterprise","enterpriseUpgrade","educationUpgrade","education","kioskUpgrade","enterpriseUpgradePerpetual","enterpriseUpgradeFixedTerm","educationUpgradePerpetual","educationUpgradeFixedTerm"],"type":"string"},"diskSpaceUsage":{"$ref":"#/components/schemas/admin_directory_v1_ByteUsage"},"diskVolumeReports":{"description":"Reports of disk space and other info about mounted/connected volumes.","type":"array","items":{"type":"object","properties":{"volumeInfo":{"description":"Disk volumes","type":"array","items":{"type":"object","properties":{"storageFree":{"description":"Free disk space [in bytes]","format":"int64","type":"string"},"storageTotal":{"description":"Total disk space [in bytes]","format":"int64","type":"string"},"volumeId":{"description":"Volume id","type":"string"}}}}}}},"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. 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 some devices.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"ethernetMacAddress":{"description":"The device's MAC address on the ethernet network interface.","type":"string"},"ethernetMacAddress0":{"description":"(Read-only) MAC address used by the Chromebook’s 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"},"extendedSupportEligible":{"description":"Output only. Whether or not the device requires the extended support opt in.","readOnly":true,"type":"boolean"},"extendedSupportEnabled":{"description":"Output only. Whether extended support policy is enabled on the device.","readOnly":true,"type":"boolean"},"extendedSupportStart":{"description":"Output only. Date of the device when extended support policy for automatic updates starts.","readOnly":true,"type":"string"},"fanInfo":{"description":"Output only. Fan information for the device.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_FanInfo"}},"firmwareVersion":{"description":"The Chrome device's firmware version.","type":"string"},"firstEnrollmentTime":{"description":"Date and time for the first time the device was enrolled.","type":"string"},"kind":{"description":"The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.","default":"admin#directory#chromeosdevice","type":"string"},"lastDeprovisionTimestamp":{"description":"(Read-only) Date and time for the last deprovision of the device.","type":"string"},"lastEnrollmentTime":{"description":"Date and time the device was last enrolled (Read-only)","format":"date-time","type":"string"},"lastKnownNetwork":{"description":"Contains last known network (Read-only)","type":"array","items":{"description":"Information for an ip address.","type":"object","properties":{"ipAddress":{"description":"The IP address.","type":"string"},"wanIpAddress":{"description":"The WAN IP address.","type":"string"}}}},"lastSync":{"description":"Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)","format":"date-time","type":"string"},"macAddress":{"description":"The device's wireless MAC address. If the device does not have this information, it is not included in the response.","type":"string"},"manufactureDate":{"description":"(Read-only) The date the device was manufactured in yyyy-mm-dd format.","type":"string"},"meid":{"description":"The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid).","type":"string"},"model":{"description":"The device's model information. If the device does not have this information, this property is not included in the response.","type":"string"},"notes":{"description":"Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.","type":"string"},"orderNumber":{"description":"The device's order number. Only devices directly purchased from Google have an order number.","type":"string"},"orgUnitId":{"description":"The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).","type":"string"},"orgUnitPath":{"description":"The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).","type":"string"},"osUpdateStatus":{"$ref":"#/components/schemas/admin_directory_v1_OsUpdateStatus"},"osVersion":{"description":"The Chrome device's operating system version.","type":"string"},"osVersionCompliance":{"description":"Output only. Device policy compliance status of the OS version.","readOnly":true,"enum":["complianceUnspecified","compliant","pending","notCompliant"],"type":"string"},"platformVersion":{"description":"The Chrome device's platform version.","type":"string"},"recentUsers":{"description":"A list of recent device users, in descending order, by last login time.","type":"array","items":{"description":"A list of recent device users, in descending order, by last login time.","type":"object","properties":{"email":{"description":"The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.","type":"string"},"type":{"description":"The type of the user.","type":"string"}}}},"screenshotFiles":{"description":"A list of screenshot files to download. Type is always \"SCREENSHOT_FILE\". (Read-only)","type":"array","items":{"type":"object","properties":{"createTime":{"description":"Date and time the file was created","format":"date-time","type":"string"},"downloadUrl":{"description":"File download URL","type":"string"},"name":{"description":"File name","type":"string"},"type":{"description":"File type","type":"string"}}}},"serialNumber":{"description":"The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.","type":"string"},"status":{"description":"The status of the device.","type":"string"},"supportEndDate":{"description":"Final date the device will be supported (Read-only)","format":"date-time","type":"string"},"systemRamFreeReports":{"description":"Reports of amounts of available RAM memory (Read-only)","type":"array","items":{"type":"object","properties":{"reportTime":{"description":"Date and time the report was received.","format":"date-time","type":"string"},"systemRamFreeInfo":{"type":"array","items":{"format":"int64","type":"string"}}}}},"systemRamTotal":{"description":"Total RAM on the device [in bytes] (Read-only)","format":"int64","type":"string"},"tpmVersionInfo":{"description":"Trusted Platform Module (TPM) (Read-only)","type":"object","properties":{"family":{"description":"TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: \"1.2\" -> 312e3200 TPM 2.0: \"2.0\" -> 322e3000","type":"string"},"firmwareVersion":{"description":"TPM firmware version.","type":"string"},"manufacturer":{"description":"TPM manufacturer code.","type":"string"},"specLevel":{"description":"TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.","type":"string"},"tpmModel":{"description":"TPM model number.","type":"string"},"vendorSpecific":{"description":"Vendor-specific information such as Vendor ID.","type":"string"}}},"willAutoRenew":{"description":"Determines if the device will auto renew its support after the support end date. This is a read-only property.","type":"boolean"}}},"admin_directory_v1_ChromeOsDeviceAction":{"description":"Data about an update to the status of a Chrome OS device.","type":"object","properties":{"action":{"description":"Action to be taken on the Chrome OS device.","type":"string"},"deprovisionReason":{"description":"Only used when the action is `deprovision`. With the `deprovision` action, this field is required. *Note*: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.","type":"string"}}},"admin_directory_v1_ChromeOsDevices":{"type":"object","properties":{"chromeosdevices":{"description":"A list of Chrome OS Device objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_ChromeOsDevice"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#chromeosdevices","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request.","type":"string"}}},"admin_directory_v1_ChromeOsMoveDevicesToOu":{"type":"object","properties":{"deviceIds":{"description":"Chrome OS devices to be moved to OU","type":"array","items":{"type":"string"}}}},"admin_directory_v1_CountChromeOsDevicesResponse":{"description":"A response for counting ChromeOS devices.","type":"object","properties":{"count":{"description":"The total number of devices matching the request.","format":"int64","type":"string"}}},"admin_directory_v1_CreatePrintServerRequest":{"description":"Request for adding a new print server.","type":"object","properties":{"parent":{"description":"Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`","type":"string"},"printServer":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}},"admin_directory_v1_CreatePrinterRequest":{"description":"Request for adding a new printer.","type":"object","properties":{"parent":{"description":"Required. The name of the customer. Format: customers/{customer_id}","type":"string"},"printer":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}},"admin_directory_v1_Customer":{"type":"object","properties":{"alternateEmail":{"description":"The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain`","type":"string"},"customerCreationTime":{"description":"The customer's creation time (Readonly)","format":"date-time","type":"string"},"customerDomain":{"description":"The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID for the customer's Google Workspace account. (Readonly)","type":"string"},"kind":{"description":"Identifies the resource as a customer. Value: `admin#directory#customer`","default":"admin#directory#customer","type":"string"},"language":{"description":"The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.","type":"string"},"phoneNumber":{"description":"The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/admin_directory_v1_CustomerPostalAddress"}}},"admin_directory_v1_CustomerPostalAddress":{"type":"object","properties":{"addressLine1":{"description":"A customer's physical address. The address can be composed of one to three lines.","type":"string"},"addressLine2":{"description":"Address line 2 of the address.","type":"string"},"addressLine3":{"description":"Address line 3 of the address.","type":"string"},"contactName":{"description":"The customer contact's name.","type":"string"},"countryCode":{"description":"This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).","type":"string"},"locality":{"description":"Name of the locality. An example of a locality value is the city of `San Francisco`.","type":"string"},"organizationName":{"description":"The company or company division name.","type":"string"},"postalCode":{"description":"The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.","type":"string"},"region":{"description":"Name of the region. An example of a region value is `NY` for the state of New York.","type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesCommand":{"description":"Information regarding a command that was issued to a device.","type":"object","properties":{"commandExpireTime":{"description":"The time at which the command will expire. If the device doesn't execute the command within this time the command will become expired.","format":"google-datetime","type":"string"},"commandId":{"description":"Unique ID of a device command.","format":"int64","type":"string"},"commandResult":{"$ref":"#/components/schemas/admin_directory_v1_DirectoryChromeosdevicesCommandResult"},"issueTime":{"description":"The timestamp when the command was issued by the admin.","format":"google-datetime","type":"string"},"payload":{"description":"The payload that the command specified, if any.","type":"string"},"state":{"description":"Indicates the command state.","enum":["STATE_UNSPECIFIED","PENDING","EXPIRED","CANCELLED","SENT_TO_CLIENT","ACKED_BY_CLIENT","EXECUTED_BY_CLIENT"],"type":"string"},"type":{"description":"The type of the command.","enum":["COMMAND_TYPE_UNSPECIFIED","REBOOT","TAKE_A_SCREENSHOT","SET_VOLUME","WIPE_USERS","REMOTE_POWERWASH","DEVICE_START_CRD_SESSION","CAPTURE_LOGS","FETCH_CRD_AVAILABILITY_INFO","FETCH_SUPPORT_PACKET"],"type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesCommandResult":{"description":"The result of executing a command.","type":"object","properties":{"commandResultPayload":{"description":"The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { \"url\": url }. The provided URL links to the Chrome Remote Desktop session and requires authentication using only the `email` associated with the command's issuance. * `FETCH_CRD_AVAILABILITY_INFO`: Payload is a stringified JSON object in the form: { \"deviceIdleTimeInSeconds\": number, \"userSessionType\": string, \"remoteSupportAvailability\": string, \"remoteAccessAvailability\": string }. The \"remoteSupportAvailability\" field is set to \"AVAILABLE\" if `shared` CRD session to the device is available. The \"remoteAccessAvailability\" field is set to \"AVAILABLE\" if `private` CRD session to the device is available.","type":"string"},"errorMessage":{"description":"The error message with a short explanation as to why the command failed. Only present if the command failed.","type":"string"},"executeTime":{"description":"The time at which the command was executed or failed to execute.","format":"google-datetime","type":"string"},"result":{"description":"The result of the command.","enum":["COMMAND_RESULT_TYPE_UNSPECIFIED","IGNORED","FAILURE","SUCCESS"],"type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesIssueCommandRequest":{"description":"A request for issuing a command.","type":"object","properties":{"commandType":{"description":"The type of command.","enum":["COMMAND_TYPE_UNSPECIFIED","REBOOT","TAKE_A_SCREENSHOT","SET_VOLUME","WIPE_USERS","REMOTE_POWERWASH","DEVICE_START_CRD_SESSION","CAPTURE_LOGS","FETCH_CRD_AVAILABILITY_INFO","FETCH_SUPPORT_PACKET"],"type":"string"},"payload":{"description":"The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true, \"crdSessionType\": string }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. `crdSessionType` can only select from values `private` (which grants the remote admin exclusive control of the ChromeOS device) or `shared` (which allows the admin and the local user to share control of the ChromeOS device). If not set, `crdSessionType` defaults to `shared`. The `FETCH_CRD_AVAILABILITY_INFO` command can be used to determine available session types on the device. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The `user_session_delay_seconds` is the amount of seconds to wait before rebooting the device if a user is logged in. It has to be an integer in the range [0,300]. When payload is not present for reboot, 0 delay is the default. Note: This only applies if an actual user is logged in, including a Guest. If the device is in the login screen or in Kiosk mode the value is not respected and the device immediately reboots. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {\"supportPacketDetails\":{ \"issueCaseId\": optional_support_case_id_string, \"issueDescription\": optional_issue_description_string, \"requestedDataCollectors\": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log).","type":"string"}}},"admin_directory_v1_DirectoryChromeosdevicesIssueCommandResponse":{"description":"A response for issuing a command.","type":"object","properties":{"commandId":{"description":"The unique ID of the issued command, used to retrieve the command status.","format":"int64","type":"string"}}},"admin_directory_v1_DirectoryUsersCreateGuestRequest":{"description":"Directory users guest creation request message.","type":"object","properties":{"customer":{"description":"Optional. Immutable ID of the Google Workspace account. Only required when request is created by a service account. Defaults to the authenticated user's customer ID otherwise.","type":"string"},"primaryGuestEmail":{"description":"Required. External email of the guest user being created.","type":"string"}}},"admin_directory_v1_DomainAlias":{"type":"object","properties":{"creationTime":{"description":"The creation time of the domain alias. (Read-only).","format":"int64","type":"string"},"domainAliasName":{"description":"The domain alias name.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domainAlias","type":"string"},"parentDomainName":{"description":"The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.","type":"string"},"verified":{"description":"Indicates the verification state of a domain alias. (Read-only)","type":"boolean"}}},"admin_directory_v1_DomainAliases":{"type":"object","properties":{"domainAliases":{"description":"A list of domain alias objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domainAliases","type":"string"}}},"admin_directory_v1_Domains":{"type":"object","properties":{"creationTime":{"description":"Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only).","format":"int64","type":"string"},"domainAliases":{"description":"A list of domain alias objects. (Read-only)","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_DomainAlias"}},"domainName":{"description":"The domain name of the customer.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"isPrimary":{"description":"Indicates if the domain is a primary domain (Read-only).","type":"boolean"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domain","type":"string"},"verified":{"description":"Indicates the verification state of a domain. (Read-only).","type":"boolean"}}},"admin_directory_v1_Domains2":{"type":"object","properties":{"domains":{"description":"A list of domain objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Domains"}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#domains","type":"string"}}},"admin_directory_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"admin_directory_v1_ExpirationDetails":{"description":"Details regarding the expiration of this role assignment. Used to automatically revoke access when the time limit is reached.","type":"object","properties":{"expireTime":{"description":"The specific timestamp when the role assignment expires.","format":"google-datetime","type":"string"}}},"admin_directory_v1_ExternalId":{"description":"External identifier used to link and identify this group across external directory systems.","type":"object","properties":{"id":{"description":"The unique identifier string assigned by the external provider.","type":"string"},"namespace":{"description":"The system or identity provider managing this ID.","type":"string"}}},"admin_directory_v1_FailureInfo":{"description":"Info about failures","type":"object","properties":{"errorCode":{"description":"Canonical code for why the update failed to apply.","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"type":"string"},"errorMessage":{"description":"Failure reason message.","type":"string"},"printer":{"$ref":"#/components/schemas/admin_directory_v1_Printer"},"printerId":{"description":"Id of a failed printer.","type":"string"}}},"admin_directory_v1_FanInfo":{"description":"Information about the device's fan.","type":"object","properties":{"speedRpm":{"description":"Output only. Fan speed in RPM.","format":"int32","readOnly":true,"type":"integer"}}},"admin_directory_v1_Feature":{"description":"JSON template for Feature object in Directory API.","type":"object","properties":{"etags":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#features#Feature","type":"string"},"name":{"description":"The name of the feature.","type":"string"}}},"admin_directory_v1_FeatureInstance":{"description":"JSON template for a feature instance.","type":"object","properties":{"feature":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}}},"admin_directory_v1_FeatureRename":{"type":"object","properties":{"newName":{"description":"New name of the feature.","type":"string"}}},"admin_directory_v1_Features":{"description":"Public API: Resources.features","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"features":{"description":"The Features in this page of results.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Feature"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#resources#features#featuresList","type":"string"},"nextPageToken":{"description":"The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.","type":"string"}}},"admin_directory_v1_Group":{"description":"Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.","type":"object","properties":{"adminCreated":{"description":"Read-only. Value is `true` if this group was created by an administrator rather than a user.","type":"boolean"},"aliases":{"description":"Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.","type":"array","items":{"type":"string"}},"description":{"description":"An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.","type":"string"},"directMembersCount":{"description":"The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.","format":"int64","type":"string"},"email":{"description":"The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"externalIds":{"description":"Optional. The list of external IDs for the group, such as an immutable identifier from an external identity provider or directory sync client. Each entry contains a namespace and an ID value.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_ExternalId"}},"id":{"description":"Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.","type":"string"},"kind":{"description":"The type of the API resource. For Groups resources, the value is `admin#directory#group`.","default":"admin#directory#group","type":"string"},"name":{"description":"The group's display name.","type":"string"},"nonEditableAliases":{"description":"Read-only. The list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored.","type":"array","items":{"type":"string"}}}},"admin_directory_v1_GroupAlias":{"description":"The Directory API manages aliases, which are alternative email addresses.","type":"object","properties":{"alias":{"description":"The alias email address.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID of the group.","type":"string"},"kind":{"description":"The type of the API resource. For Alias resources, the value is `admin#directory#alias`.","type":"string"},"primaryEmail":{"description":"The primary email address of the group.","type":"string"}}},"admin_directory_v1_Groups":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"groups":{"description":"A list of group objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Group"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#groups","type":"string"},"nextPageToken":{"description":"Token used to access next page of this result.","type":"string"}}},"admin_directory_v1_GuestAccountInfo":{"description":"Account info specific to Guest users.","type":"object","properties":{"primaryGuestEmail":{"description":"Immutable. The guest's external email.","type":"string"}}},"admin_directory_v1_ListPrintServersResponse":{"type":"object","properties":{"nextPageToken":{"description":"A token that can be sent as `page_token` in a request to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"printServers":{"description":"List of print servers.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"}}}},"admin_directory_v1_ListPrinterModelsResponse":{"description":"Response for listing allowed printer models.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"printerModels":{"description":"Printer models that are currently allowed to be configured for ChromeOs. Some printers may be added or removed over time.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_PrinterModel"}}}},"admin_directory_v1_ListPrintersResponse":{"description":"Response for listing printers.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"printers":{"description":"List of printers. If `org_unit_id` was given in the request, then only printers visible for this OU will be returned. If `org_unit_id` was not given in the request, then all printers will be returned.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Printer"}}}},"admin_directory_v1_Member":{"description":"A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).","type":"object","properties":{"delivery_settings":{"description":"Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.","type":"string"},"email":{"description":"The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.","type":"string"},"kind":{"description":"The type of the API resource. For Members resources, the value is `admin#directory#member`.","default":"admin#directory#member","type":"string"},"role":{"description":"The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).","type":"string"},"status":{"description":"Status of member (Immutable)","type":"string"},"type":{"description":"The type of group member.","type":"string"}}},"admin_directory_v1_Members":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#members","type":"string"},"members":{"description":"A list of member objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Member"}},"nextPageToken":{"description":"Token used to access next page of this result.","type":"string"}}},"admin_directory_v1_MembersHasMember":{"description":"JSON template for Has Member response in Directory API.","type":"object","properties":{"isMember":{"description":"Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested.","readOnly":true,"type":"boolean"}}},"admin_directory_v1_MobileDevice":{"description":"Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices.html).","type":"object","properties":{"adbStatus":{"description":"Adb (USB debugging) enabled or disabled on device (Read-only)","type":"boolean"},"applications":{"description":"The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.","type":"array","items":{"type":"object","properties":{"displayName":{"description":"The application's display name. An example is `Browser`.","type":"string"},"packageName":{"description":"The application's package name. An example is `com.android.browser`.","type":"string"},"permission":{"description":"The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's [Android manifest](https://developer.android.com/guide/topics/manifest/uses-permission-element.html). Examples of a Calendar application's permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`.","type":"array","items":{"type":"string"}},"versionCode":{"description":"The application's version code. An example is `13`.","format":"int32","type":"integer"},"versionName":{"description":"The application's version name. An example is `3.2-140714`.","type":"string"}}}},"basebandVersion":{"description":"The device's baseband version.","type":"string"},"bootloaderVersion":{"description":"Mobile Device Bootloader version (Read-only)","type":"string"},"brand":{"description":"Mobile Device Brand (Read-only)","type":"string"},"buildNumber":{"description":"The device's operating system build number.","type":"string"},"defaultLanguage":{"description":"The default locale used on the device.","type":"string"},"developerOptionsStatus":{"description":"Developer options enabled or disabled on device (Read-only)","type":"boolean"},"deviceCompromisedStatus":{"description":"The compromised device status.","type":"string"},"deviceId":{"description":"The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.","type":"string"},"devicePasswordStatus":{"description":"DevicePasswordStatus (Read-only)","type":"string"},"email":{"description":"The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method.","type":"array","items":{"type":"string"}},"encryptionStatus":{"description":"Mobile Device Encryption Status (Read-only)","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"firstSync":{"description":"Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)","format":"date-time","type":"string"},"hardware":{"description":"Mobile Device Hardware (Read-only)","type":"string"},"hardwareId":{"description":"The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.","type":"string"},"imei":{"description":"The device's IMEI number.","type":"string"},"kernelVersion":{"description":"The device's kernel version.","type":"string"},"kind":{"description":"The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.","default":"admin#directory#mobiledevice","type":"string"},"lastSync":{"description":"Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)","format":"date-time","type":"string"},"managedAccountIsOnOwnerProfile":{"description":"Boolean indicating if this account is on owner/primary profile or not.","type":"boolean"},"manufacturer":{"description":"Mobile Device manufacturer (Read-only)","type":"string"},"meid":{"description":"The device's MEID number.","type":"string"},"model":{"description":"The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device).","type":"string"},"name":{"description":"The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user).","type":"array","items":{"type":"string"}},"networkOperator":{"description":"Mobile Device mobile or network operator (if available) (Read-only)","type":"string"},"os":{"description":"The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).","type":"string"},"otherAccountsInfo":{"description":"The list of accounts added on device (Read-only)","type":"array","items":{"type":"string"}},"privilege":{"description":"DMAgentPermission (Read-only)","type":"string"},"releaseVersion":{"description":"Mobile Device release version version (Read-only)","type":"string"},"resourceId":{"description":"The unique ID the API service uses to identify the mobile device.","type":"string"},"securityPatchLevel":{"description":"Mobile Device Security patch level (Read-only)","format":"int64","type":"string"},"serialNumber":{"description":"The device's serial number.","type":"string"},"status":{"description":"The device's status.","type":"string"},"supportsWorkProfile":{"description":"Work profile supported on device (Read-only)","type":"boolean"},"type":{"description":"The type of mobile device.","type":"string"},"unknownSourcesStatus":{"description":"Unknown sources enabled or disabled on device (Read-only)","type":"boolean"},"userAgent":{"description":"Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).","type":"string"},"wifiMacAddress":{"description":"The device's MAC address on Wi-Fi networks.","type":"string"}}},"admin_directory_v1_MobileDeviceAction":{"type":"object","properties":{"action":{"description":"The action to be performed on the device.","type":"string"}}},"admin_directory_v1_MobileDevices":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#mobiledevices","type":"string"},"mobiledevices":{"description":"A list of Mobile Device objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_MobileDevice"}},"nextPageToken":{"description":"Token used to access next page of this result.","type":"string"}}},"admin_directory_v1_OrgUnit":{"description":"Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.","type":"object","properties":{"blockInheritance":{"description":"This field is deprecated and setting its value has no effect.","type":"boolean"},"description":{"description":"Description of the organizational unit.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.","default":"admin#directory#orgUnit","type":"string"},"name":{"description":"The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.","type":"string"},"orgUnitId":{"description":"The unique ID of the organizational unit.","type":"string"},"orgUnitPath":{"description":"The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).","type":"string"},"parentOrgUnitId":{"description":"The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.","type":"string"},"parentOrgUnitPath":{"description":"The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.","type":"string"}}},"admin_directory_v1_OrgUnits":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.","default":"admin#directory#orgUnits","type":"string"},"organizationUnits":{"description":"A list of organizational unit objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_OrgUnit"}}}},"admin_directory_v1_OsUpdateStatus":{"description":"Contains information regarding the current OS update status.","type":"object","properties":{"rebootTime":{"description":"Date and time of the last reboot.","type":"string"},"state":{"description":"The update state of an OS update.","enum":["updateStateUnspecified","updateStateNotStarted","updateStateDownloadInProgress","updateStateNeedReboot"],"type":"string"},"targetKioskAppVersion":{"description":"New required platform version from the pending updated kiosk app.","type":"string"},"targetOsVersion":{"description":"New platform version of the OS image being downloaded and applied. It is only set when update status is UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this could be a dummy \"0.0.0.0\" for UPDATE_STATUS_NEED_REBOOT for some edge cases, e.g. update engine is restarted without a reboot.","type":"string"},"updateCheckTime":{"description":"Date and time of the last update check.","type":"string"},"updateTime":{"description":"Date and time of the last successful OS update.","type":"string"}}},"admin_directory_v1_PrintServer":{"description":"Configuration for a print server.","type":"object","properties":{"createTime":{"description":"Output only. Time when the print server was created.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Editable. Description of the print server (as shown in the Admin console).","type":"string"},"displayName":{"description":"Editable. Display name of the print server (as shown in the Admin console).","type":"string"},"id":{"description":"Immutable. ID of the print server. Leave empty when creating.","type":"string"},"name":{"description":"Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`","type":"string"},"orgUnitId":{"description":"ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).","type":"string"},"uri":{"description":"Editable. Print server URI.","type":"string"}}},"admin_directory_v1_PrintServerFailureInfo":{"description":"Info about failures","type":"object","properties":{"errorCode":{"description":"Canonical code for why the update failed to apply.","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"type":"string"},"errorMessage":{"description":"Failure reason message.","type":"string"},"printServer":{"$ref":"#/components/schemas/admin_directory_v1_PrintServer"},"printServerId":{"description":"ID of a failed print server.","type":"string"}}},"admin_directory_v1_Printer":{"description":"Printer configuration.","type":"object","properties":{"auxiliaryMessages":{"description":"Output only. Auxiliary messages about issues with the printer configuration if any.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_AuxiliaryMessage"}},"createTime":{"description":"Output only. Time when printer was created.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Editable. Description of printer.","type":"string"},"displayName":{"description":"Editable. Name of printer.","type":"string"},"id":{"description":"Id of the printer. (During printer creation leave empty)","type":"string"},"makeAndModel":{"description":"Editable. Make and model of printer. e.g. Lexmark MS610de Value must be in format as seen in ListPrinterModels response.","type":"string"},"name":{"description":"Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty)","type":"string"},"orgUnitId":{"description":"Organization Unit that owns this printer (Only can be set during Printer creation)","type":"string"},"uri":{"description":"Editable. Printer URI.","type":"string"},"useDriverlessConfig":{"description":"Editable. flag to use driverless configuration or not. If it's set to be true, make_and_model can be ignored","type":"boolean"}}},"admin_directory_v1_PrinterModel":{"description":"Printer manufacturer and model","type":"object","properties":{"displayName":{"description":"Display name. eq. \"Brother MFC-8840D\"","type":"string"},"makeAndModel":{"description":"Make and model as represented in \"make_and_model\" field in Printer object. eq. \"brother mfc-8840d\"","type":"string"},"manufacturer":{"description":"Manufacturer. eq. \"Brother\"","type":"string"}}},"admin_directory_v1_Privilege":{"type":"object","properties":{"childPrivileges":{"description":"A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Privilege"}},"etag":{"description":"ETag of the resource.","type":"string"},"isOuScopable":{"description":"If the privilege can be restricted to an organization unit.","type":"boolean"},"kind":{"description":"The type of the API resource. This is always `admin#directory#privilege`.","default":"admin#directory#privilege","type":"string"},"privilegeName":{"description":"The name of the privilege.","type":"string"},"serviceId":{"description":"The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).","type":"string"},"serviceName":{"description":"The name of the service this privilege is for.","type":"string"}}},"admin_directory_v1_Privileges":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of Privilege resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Privilege"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#privileges`.","default":"admin#directory#privileges","type":"string"}}},"admin_directory_v1_Role":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"isSuperAdminRole":{"description":"Returns `true` if the role is a super admin role.","type":"boolean"},"isSystemRole":{"description":"Returns `true` if this is a pre-defined system role.","type":"boolean"},"kind":{"description":"The type of the API resource. This is always `admin#directory#role`.","default":"admin#directory#role","type":"string"},"roleDescription":{"description":"A short description of the role.","type":"string"},"roleId":{"description":"ID of the role.","format":"int64","type":"string"},"roleName":{"description":"Name of the role.","type":"string"},"rolePrivileges":{"description":"The set of privileges that are granted to this role.","type":"array","items":{"type":"object","properties":{"privilegeName":{"description":"The name of the privilege.","type":"string"},"serviceId":{"description":"The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).","type":"string"}}}}}},"admin_directory_v1_RoleAssignment":{"description":"Defines an assignment of a role.","type":"object","properties":{"assignedTo":{"description":"The unique ID of the entity this role is assigned to—either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).","type":"string"},"assigneeType":{"description":"Output only. The type of the assignee (`USER` or `GROUP`).","readOnly":true,"enum":["user","group"],"type":"string"},"condition":{"description":"Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"expirationDetails":{"$ref":"#/components/schemas/admin_directory_v1_ExpirationDetails"},"kind":{"description":"The type of the API resource. This is always `admin#directory#roleAssignment`.","default":"admin#directory#roleAssignment","type":"string"},"orgUnitId":{"description":"If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.","type":"string"},"roleAssignmentId":{"description":"ID of this roleAssignment.","format":"int64","type":"string"},"roleId":{"description":"The ID of the role that is assigned.","format":"int64","type":"string"},"scopeType":{"description":"The scope in which this role is assigned.","type":"string"}}},"admin_directory_v1_RoleAssignments":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of RoleAssignment resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_RoleAssignment"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#roleAssignments`.","default":"admin#directory#roleAssignments","type":"string"},"nextPageToken":{"type":"string"}}},"admin_directory_v1_Roles":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of Role resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Role"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#roles`.","default":"admin#directory#roles","type":"string"},"nextPageToken":{"type":"string"}}},"admin_directory_v1_Schema":{"description":"The type of API resource. For Schema resources, this is always `admin#directory#schema`.","type":"object","properties":{"displayName":{"description":"Display name for the schema.","type":"string"},"etag":{"description":"The ETag of the resource.","type":"string"},"fields":{"description":"A list of fields in the schema.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_SchemaFieldSpec"}},"kind":{"description":"Kind of resource this is.","default":"admin#directory#schema","type":"string"},"schemaId":{"description":"The unique identifier of the schema (Read-only)","type":"string"},"schemaName":{"description":"The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.","type":"string"}}},"admin_directory_v1_SchemaFieldSpec":{"description":"You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).","type":"object","properties":{"displayName":{"description":"Display Name of the field.","type":"string"},"etag":{"description":"The ETag of the field.","type":"string"},"fieldId":{"description":"The unique identifier of the field (Read-only)","type":"string"},"fieldName":{"description":"The name of the field.","type":"string"},"fieldType":{"description":"The type of the field.","type":"string"},"indexed":{"description":"Boolean specifying whether the field is indexed or not. Default: `true`.","default":true,"type":"boolean"},"kind":{"description":"The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.","default":"admin#directory#schema#fieldspec","type":"string"},"multiValued":{"description":"A boolean specifying whether this is a multi-valued field or not. Default: `false`.","type":"boolean"},"numericIndexingSpec":{"description":"Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.","type":"object","properties":{"maxValue":{"description":"Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.","format":"double","type":"number"},"minValue":{"description":"Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.","format":"double","type":"number"}}},"readAccessType":{"description":"Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.","default":"ALL_DOMAIN_USERS","type":"string"}}},"admin_directory_v1_Schemas":{"description":"JSON response template for List Schema operation in Directory API.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#schemas","type":"string"},"schemas":{"description":"A list of UserSchema objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Schema"}}}},"admin_directory_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"admin_directory_v1_Token":{"description":"JSON template for token resource in Directory API.","type":"object","properties":{"anonymous":{"description":"Whether the application is registered with Google. The value is `true` if the application has an anonymous Client ID.","type":"boolean"},"clientId":{"description":"The Client ID of the application the token is issued to.","type":"string"},"displayText":{"description":"The displayable name of the application the token is issued to.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the API resource. This is always `admin#directory#token`.","default":"admin#directory#token","type":"string"},"nativeApp":{"description":"Whether the token is issued to an installed application. The value is `true` if the application is installed to a desktop or mobile device.","type":"boolean"},"scopes":{"description":"A list of authorization scopes the application is granted.","type":"array","items":{"type":"string"}},"userKey":{"description":"The unique ID of the user that issued the token.","type":"string"}}},"admin_directory_v1_Tokens":{"description":"JSON response template for List tokens operation in Directory API.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of Token resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_Token"}},"kind":{"description":"The type of the API resource. This is always `admin#directory#tokenList`.","default":"admin#directory#tokenList","type":"string"}}},"admin_directory_v1_User":{"description":"The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).","type":"object","properties":{"addresses":{"description":"The list of the user's addresses. The maximum allowed data size for this field is 10KB."},"agreedToTerms":{"description":"Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.","readOnly":true,"type":"boolean"},"aliases":{"description":"Output only. The list of the user's alias email addresses.","readOnly":true,"type":"array","items":{"type":"string"}},"archivalTime":{"description":"Output only. User's account archival time. (Read-only)","readOnly":true,"type":"string"},"archived":{"description":"Indicates if user is archived.","type":"boolean"},"changePasswordAtNextLogin":{"description":"Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224).","type":"boolean"},"creationTime":{"description":"User's G Suite account creation time. (Read-only)","format":"date-time","readOnly":true,"type":"string"},"customSchemas":{"description":"Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.","type":"object","additionalProperties":{"$ref":"#/components/schemas/admin_directory_v1_UserCustomProperties"}},"customerId":{"description":"Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.","readOnly":true,"type":"string"},"deletionTime":{"format":"date-time","readOnly":true,"type":"string"},"emails":{"description":"The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`."},"etag":{"description":"Output only. ETag of the resource.","readOnly":true,"type":"string"},"externalIds":{"description":"The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB."},"gender":{"description":"The user's gender. The maximum allowed data size for this field is 1KB."},"guestAccountInfo":{"$ref":"#/components/schemas/admin_directory_v1_GuestAccountInfo"},"hashFunction":{"description":"Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.","type":"string"},"id":{"description":"The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.","type":"string"},"ims":{"description":"The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB."},"includeInGlobalAddressList":{"description":"Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).","type":"boolean"},"ipWhitelisted":{"description":"If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.","type":"boolean"},"isAdmin":{"description":"Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.","readOnly":true,"type":"boolean"},"isDelegatedAdmin":{"description":"Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).","readOnly":true,"type":"boolean"},"isEnforcedIn2Sv":{"description":"Output only. Is 2-step verification enforced (Read-only)","readOnly":true,"type":"boolean"},"isEnrolledIn2Sv":{"description":"Output only. Is enrolled in 2-step verification (Read-only)","readOnly":true,"type":"boolean"},"isGuestUser":{"description":"Immutable. Indicates if the inserted user is a guest.","type":"boolean"},"isMailboxSetup":{"description":"Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.","readOnly":true,"type":"boolean"},"keywords":{"description":"The list of the user's keywords. The maximum allowed data size for this field is 1KB."},"kind":{"description":"Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.","readOnly":true,"default":"admin#directory#user","type":"string"},"languages":{"description":"The user's languages. The maximum allowed data size for this field is 1KB."},"lastLoginTime":{"description":"User's last login time. (Read-only)","format":"date-time","readOnly":true,"type":"string"},"locations":{"description":"The user's locations. The maximum allowed data size for this field is 10KB."},"name":{"$ref":"#/components/schemas/admin_directory_v1_UserName"},"nonEditableAliases":{"description":"Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.","readOnly":true,"type":"array","items":{"type":"string"}},"notes":{"description":"Notes for the user."},"orgUnitPath":{"description":"The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`).","type":"string"},"organizations":{"description":"The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB."},"password":{"description":"User's password","type":"string"},"phones":{"description":"The list of the user's phone numbers. The maximum allowed data size for this field is 1KB."},"posixAccounts":{"description":"The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user."},"primaryEmail":{"description":"The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another 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":{"description":"The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB."},"sshPublicKeys":{"description":"A list of SSH public keys."},"suspended":{"description":"Indicates if user is suspended.","type":"boolean"},"suspensionReason":{"description":"Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`.","readOnly":true,"type":"string"},"suspensionTime":{"description":"Output only. User's account suspension time. (Read-only)","readOnly":true,"type":"string"},"thumbnailPhotoEtag":{"description":"Output only. ETag of the user's photo (Read-only)","readOnly":true,"type":"string"},"thumbnailPhotoUrl":{"description":"Output only. The URL of the user's profile photo. The URL might be temporary or private.","readOnly":true,"type":"string"},"websites":{"description":"The user's websites. The maximum allowed data size for this field is 2KB."}}},"admin_directory_v1_UserAbout":{"description":"JSON template for About (notes) of a user in Directory API.","type":"object","properties":{"contentType":{"description":"About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text.","type":"string"},"value":{"description":"Actual value of notes.","type":"string"}}},"admin_directory_v1_UserAddress":{"description":"JSON template for address.","type":"object","properties":{"country":{"description":"Country.","type":"string"},"countryCode":{"description":"Country code.","type":"string"},"customType":{"description":"Custom type.","type":"string"},"extendedAddress":{"description":"Extended Address.","type":"string"},"formatted":{"description":"Formatted address.","type":"string"},"locality":{"description":"Locality.","type":"string"},"poBox":{"description":"Other parts of address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"primary":{"description":"If this is user's primary address. Only one entry could be marked as primary.","type":"boolean"},"region":{"description":"Region.","type":"string"},"sourceIsStructured":{"description":"User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses but any values will eventually be clobbered.","type":"boolean"},"streetAddress":{"description":"Street.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard values of that entry. For example address could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserAlias":{"description":"The Directory API manages aliases, which are alternative email addresses.","type":"object","properties":{"alias":{"description":"The alias email address.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The unique ID for the user.","type":"string"},"kind":{"description":"The type of the API resource. For Alias resources, the value is `admin#directory#alias`.","type":"string"},"primaryEmail":{"description":"The user's primary email address.","type":"string"}}},"admin_directory_v1_UserCustomProperties":{"description":"JSON template for a set of custom properties (i.e. all fields in a particular schema)","type":"object","additionalProperties":{}},"admin_directory_v1_UserEmail":{"description":"JSON template for an email.","type":"object","properties":{"address":{"description":"Email id of the user.","type":"string"},"customType":{"description":"Custom Type.","type":"string"},"primary":{"description":"If this is user's primary email. Only one entry could be marked as primary.","type":"boolean"},"public_key_encryption_certificates":{"description":"Public Key Encryption Certificates. Current limit: 1 per email address, and 5 per user.","type":"object","properties":{"certificate":{"description":"X.509 encryption certificate in `PEM` format. Must only be an end-entity (leaf) certificate.","type":"string"},"is_default":{"description":"Whether this is the default certificate for the given email address.","type":"boolean"},"state":{"description":"Denotes the certificate's state in its lifecycle. Possible values are `not_yet_validated`, `valid`, `invalid`, `expired`, and `revoked`.","type":"string"}}},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserExternalId":{"description":"JSON template for an externalId entry.","type":"object","properties":{"customType":{"description":"Custom type.","type":"string"},"type":{"description":"The type of the Id.","type":"string"},"value":{"description":"The value of the id.","type":"string"}}},"admin_directory_v1_UserGender":{"type":"object","properties":{"addressMeAs":{"description":"AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans for example he/him/his or they/them/their.","type":"string"},"customGender":{"description":"Custom gender.","type":"string"},"type":{"description":"Gender.","type":"string"}}},"admin_directory_v1_UserIm":{"description":"JSON template for instant messenger of an user.","type":"object","properties":{"customProtocol":{"description":"Custom protocol.","type":"string"},"customType":{"description":"Custom type.","type":"string"},"im":{"description":"Instant messenger id.","type":"string"},"primary":{"description":"If this is user's primary im. Only one entry could be marked as primary.","type":"boolean"},"protocol":{"description":"Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type it can take a CUSTOM value and specify the custom name in customProtocol field.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home work etc. In addition to the standard type an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserKeyword":{"description":"JSON template for a keyword entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard type of that entry. For example keyword could be of type occupation or outlook. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"},"value":{"description":"Keyword.","type":"string"}}},"admin_directory_v1_UserLanguage":{"description":"JSON template for a language entry.","type":"object","properties":{"customLanguage":{"description":"Other language. User can provide their own language name if there is no corresponding ISO 639 language code. If this is set, `languageCode` can't be set.","type":"string"},"languageCode":{"description":"ISO 639 string representation of a language. See [Language Codes](/admin-sdk/directory/v1/languages) for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. Illegal values cause `SchemaException`. If this is set, `customLanguage` can't be set.","type":"string"},"preference":{"description":"Optional. If present, controls whether the specified `languageCode` is the user's preferred language. If `customLanguage` is set, this can't be set. Allowed values are `preferred` and `not_preferred`.","type":"string"}}},"admin_directory_v1_UserLocation":{"description":"JSON template for a location entry.","type":"object","properties":{"area":{"description":"Required. Textual location. This is most useful for display purposes to concisely describe the location. For example 'Mountain View, CA', 'Near Seattle', 'US-NYC-9TH 9A209A.''","type":"string"},"buildingId":{"description":"Building Identifier.","type":"string"},"customType":{"description":"Custom Type.","type":"string"},"deskCode":{"description":"Most specific textual code of individual desk location.","type":"string"},"floorName":{"description":"Floor name/number.","type":"string"},"floorSection":{"description":"Floor section. More specific location within the floor. For example if a floor is divided into sections 'A', 'B' and 'C' this field would identify one of those values.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example location could be of types default and desk. In addition to standard type an entry can have a custom type and can give it any name. Such types should have 'custom' as type and also have a customType value.","type":"string"}}},"admin_directory_v1_UserMakeAdmin":{"type":"object","properties":{"status":{"description":"Indicates the administrator status of the user.","type":"boolean"}}},"admin_directory_v1_UserName":{"type":"object","properties":{"displayName":{"description":"The user's display name. Limit: 256 characters.","type":"string"},"familyName":{"description":"The user's last name. Required when creating a user account.","type":"string"},"fullName":{"description":"The user's full name formed by concatenating the first and last name values.","type":"string"},"givenName":{"description":"The user's first name. Required when creating a user account.","type":"string"}}},"admin_directory_v1_UserOrganization":{"description":"JSON template for an organization entry.","type":"object","properties":{"costCenter":{"description":"The cost center of the users department.","type":"string"},"customType":{"description":"Custom type.","type":"string"},"department":{"description":"Department within the organization.","type":"string"},"description":{"description":"Description of the organization.","type":"string"},"domain":{"description":"The domain to which the organization belongs to.","type":"string"},"fullTimeEquivalent":{"description":"The full-time equivalent millipercent within the organization (100000 = 100%).","format":"int32","type":"integer"},"location":{"description":"Location of the organization. This need not be fully qualified address.","type":"string"},"name":{"description":"Name of the organization","type":"string"},"primary":{"description":"If it user's primary organization.","type":"boolean"},"symbol":{"description":"Symbol of the organization.","type":"string"},"title":{"description":"Title (designation) of the user in the organization.","type":"string"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example organization could be of school work etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value.","type":"string"}}},"admin_directory_v1_UserPhone":{"description":"JSON template for a phone entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"primary":{"description":"If this is user's primary phone or not.","type":"boolean"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax work mobile etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"},"value":{"description":"Phone number.","type":"string"}}},"admin_directory_v1_UserPhoto":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"height":{"description":"Height of the photo in pixels.","format":"int32","type":"integer"},"id":{"description":"The ID the API uses to uniquely identify the user.","type":"string"},"kind":{"description":"The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.","default":"admin#directory#user#photo","type":"string"},"mimeType":{"description":"The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.","type":"string"},"photoData":{"description":"The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.","format":"byte","type":"string"},"primaryEmail":{"description":"The user's primary email address.","type":"string"},"width":{"description":"Width of the photo in pixels.","format":"int32","type":"integer"}}},"admin_directory_v1_UserPosixAccount":{"description":"JSON template for a POSIX account entry.","type":"object","properties":{"accountId":{"description":"A POSIX account field identifier.","type":"string"},"gecos":{"description":"The GECOS (user information) for this account.","type":"string"},"gid":{"description":"The default group ID.","format":"uint64","type":"string"},"homeDirectory":{"description":"The path to the home directory for this account.","type":"string"},"operatingSystemType":{"description":"The operating system type for this account.","type":"string"},"primary":{"description":"If this is user's primary account within the SystemId.","type":"boolean"},"shell":{"description":"The path to the login shell for this account.","type":"string"},"systemId":{"description":"System identifier for which account Username or Uid apply to.","type":"string"},"uid":{"description":"The POSIX compliant user ID.","format":"uint64","type":"string"},"username":{"description":"The username of the account.","type":"string"}}},"admin_directory_v1_UserRelation":{"description":"JSON template for a relation entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"type":{"description":"The relation of the user. Some of the possible values are mother father sister brother manager assistant partner.","type":"string"},"value":{"description":"The name of the relation.","type":"string"}}},"admin_directory_v1_UserSshPublicKey":{"description":"JSON template for a POSIX account entry.","type":"object","properties":{"expirationTimeUsec":{"description":"An expiration time in microseconds since epoch.","format":"int64","type":"string"},"fingerprint":{"description":"A SHA-256 fingerprint of the SSH public key. (Read-only)","readOnly":true,"type":"string"},"key":{"description":"An SSH public key.","type":"string"}}},"admin_directory_v1_UserUndelete":{"type":"object","properties":{"orgUnitPath":{"description":"OrgUnit of User","type":"string"}}},"admin_directory_v1_UserWebsite":{"description":"JSON template for a website entry.","type":"object","properties":{"customType":{"description":"Custom Type.","type":"string"},"primary":{"description":"If this is user's primary website or not.","type":"boolean"},"type":{"description":"Each entry can have a type which indicates standard types of that entry. For example website could be of home work blog etc. In addition to the standard type an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value.","type":"string"},"value":{"description":"Website.","type":"string"}}},"admin_directory_v1_Users":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"Kind of resource this is.","default":"admin#directory#users","type":"string"},"nextPageToken":{"description":"Token used to access next page of this result. The page token is only valid for three days.","type":"string"},"trigger_event":{"description":"Event that triggered this response (only used in case of Push Response)","type":"string"},"users":{"description":"A list of user objects.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_User"}}}},"admin_directory_v1_VerificationCode":{"description":"The Directory API allows you to view, generate, and invalidate backup verification codes for a user.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of the resource. This is always `admin#directory#verificationCode`.","default":"admin#directory#verificationCode","type":"string"},"userId":{"description":"The obfuscated unique ID of the user.","type":"string"},"verificationCode":{"description":"A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.","type":"string"}}},"admin_directory_v1_VerificationCodes":{"description":"JSON response template for list verification codes operation in Directory API.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"A list of verification code resources.","type":"array","items":{"$ref":"#/components/schemas/admin_directory_v1_VerificationCode"}},"kind":{"description":"The type of the resource. This is always `admin#directory#verificationCodesList`.","default":"admin#directory#verificationCodesList","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/admin.chrome.printers":"See, add, edit, and permanently delete the printers that your organization can use with Chrome","https://www.googleapis.com/auth/admin.directory.customer":"View and manage customer related information","https://www.googleapis.com/auth/admin.directory.device.chromeos":"View and manage your ChromeOS devices' metadata","https://www.googleapis.com/auth/admin.directory.device.mobile":"View and manage your mobile devices' metadata","https://www.googleapis.com/auth/admin.directory.domain":"View and manage the provisioning of domains for your customers","https://www.googleapis.com/auth/admin.directory.group":"View and manage the provisioning of groups on your domain","https://www.googleapis.com/auth/admin.directory.orgunit":"View and manage organization units on your domain","https://www.googleapis.com/auth/admin.directory.resource.calendar":"View and manage the provisioning of calendar resources on your domain","https://www.googleapis.com/auth/admin.directory.rolemanagement":"Manage delegated admin roles for your domain","https://www.googleapis.com/auth/admin.directory.user":"View and manage the provisioning of users on your domain","https://www.googleapis.com/auth/admin.directory.user.security":"Manage data access permissions for users on your domain","https://www.googleapis.com/auth/admin.directory.userschema":"View and manage the provisioning of user schemas on your domain","https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly":"View delegated admin roles for your domain","https://www.googleapis.com/auth/admin.directory.user.alias":"View and manage user aliases on your domain","https://www.googleapis.com/auth/admin.directory.user.alias.readonly":"View user aliases on your domain","https://www.googleapis.com/auth/admin.directory.user.readonly":"See info about users on your domain","https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly":"View your ChromeOS devices' metadata","https://www.googleapis.com/auth/admin.directory.domain.readonly":"View domains related to your customers","https://www.googleapis.com/auth/admin.directory.userschema.readonly":"View user schemas on your domain","https://www.googleapis.com/auth/admin.directory.customer.readonly":"View customer related information","https://www.googleapis.com/auth/admin.chrome.printers.readonly":"See the printers that your organization can use with Chrome","https://www.googleapis.com/auth/admin.directory.group.readonly":"View groups on your domain","https://www.googleapis.com/auth/admin.directory.device.mobile.action":"Manage your mobile devices by performing administrative tasks","https://www.googleapis.com/auth/admin.directory.device.mobile.readonly":"View your mobile devices' metadata","https://www.googleapis.com/auth/admin.directory.group.member":"View and manage group subscriptions on your domain","https://www.googleapis.com/auth/admin.directory.group.member.readonly":"View group subscriptions on your domain","https://www.googleapis.com/auth/admin.directory.orgunit.readonly":"View organization units on your domain","https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly":"View calendar resources on your domain"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/admin.chrome.printers","https://www.googleapis.com/auth/admin.directory.customer","https://www.googleapis.com/auth/admin.directory.device.chromeos","https://www.googleapis.com/auth/admin.directory.device.mobile","https://www.googleapis.com/auth/admin.directory.domain","https://www.googleapis.com/auth/admin.directory.group","https://www.googleapis.com/auth/admin.directory.orgunit","https://www.googleapis.com/auth/admin.directory.resource.calendar","https://www.googleapis.com/auth/admin.directory.rolemanagement","https://www.googleapis.com/auth/admin.directory.user","https://www.googleapis.com/auth/admin.directory.user.security","https://www.googleapis.com/auth/admin.directory.userschema"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/admin/directory_v1/rest","service":"admin","version":"directory_v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-admin-reports.json b/public/specs/google/google-admin-reports.json index b6591244..ea656c5e 100644 --- a/public/specs/google/google-admin-reports.json +++ b/public/specs/google/google-admin-reports.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Admin SDK API","version":"reports_v1","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."},"servers":[{"url":"https://admin.googleapis.com/"}],"paths":{"/admin/reports/v1/activity/users/{userKey}/applications/{applicationName}":{"get":{"operationId":"reports.activities.list","x-executor-toolPath":"reports.activities.list","tags":["Admin SDK API"],"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.","parameters":[{"name":"userKey","in":"path","required":true,"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`.","schema":{"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`.","type":"string"}},{"name":"applicationName","in":"path","required":true,"description":"Application name for which the events are to be retrieved.","schema":{"description":"Application name for which the events are to be retrieved.","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","voice","chrome_sync","workspace_studio","gemini_notebook"],"type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"actorIpAddress","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"agentInfoFilter","in":"query","required":false,"description":"Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example: \"agentInfoFilter=agentId=\\\"agent-id\\\" AND agentName=\\\"agent-name\\\" AND agentOwnerEmail=\\\"agent-owner-email\\\"\"","schema":{"description":"Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example: \"agentInfoFilter=agentId=\\\"agent-id\\\" AND agentName=\\\"agent-name\\\" AND agentOwnerEmail=\\\"agent-owner-email\\\"\"","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"applicationInfoFilter","in":"query","required":false,"description":"Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId=\"clientId\" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```","schema":{"description":"Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId=\"clientId\" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```","type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"deviceFilter","in":"query","required":false,"description":"Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and `deviceOsVersion`. **Usage** ``` GET...&deviceFilter=deviceId=\"123\" GET...&deviceFilter=deviceType=\"ANDROID\" GET...&deviceFilter=deviceOsVersion=\"14.0\" ```","schema":{"description":"Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and `deviceOsVersion`. **Usage** ``` GET...&deviceFilter=deviceId=\"123\" GET...&deviceFilter=deviceType=\"ANDROID\" GET...&deviceFilter=deviceOsVersion=\"14.0\" ```","type":"string"},"style":"form","explode":false},{"name":"endTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"eventName","in":"query","required":false,"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`.","schema":{"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`.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","schema":{"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","type":"string"},"style":"form","explode":false},{"name":"groupIdFilter","in":"query","required":false,"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](https://support.google.com/a/answer/11482175)","schema":{"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](https://support.google.com/a/answer/11482175)","type":"string"},"style":"form","explode":false},{"name":"includeSensitiveData","in":"query","required":false,"description":"Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter is supported only for Rules (DLP), Chat and Workspace Studio applications; using it with any other application will result in a permission error.","schema":{"description":"Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter is supported only for Rules (DLP), Chat and Workspace Studio applications; using it with any other application will result in a permission error.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"networkInfoFilter","in":"query","required":false,"description":"Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode=\"IN\" GET...&networkInfoFilter=regionCode=%22IN%22 ```","schema":{"description":"Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode=\"IN\" GET...&networkInfoFilter=regionCode=%22IN%22 ```","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitID","in":"query","required":false,"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.","schema":{"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.","default":"","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"resourceDetailsFilter","in":"query","required":false,"description":"Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) 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`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#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`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#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`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported.","schema":{"description":"Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) 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`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#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`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#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`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported.","type":"string"},"style":"form","explode":false},{"name":"startTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"statusFilter","in":"query","required":false,"description":"Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode=\"200\" GET...&statusFilter=statusCode=%22200%22 ```","schema":{"description":"Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode=\"200\" GET...&statusFilter=statusCode=%22200%22 ```","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Activities"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}},"/admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch":{"post":{"operationId":"reports.activities.watch","x-executor-toolPath":"reports.activities.watch","tags":["Admin SDK API"],"description":"Start receiving notifications for account activities. For more information, see Receiving Push Notifications.","parameters":[{"name":"userKey","in":"path","required":true,"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`.","schema":{"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`.","type":"string"}},{"name":"applicationName","in":"path","required":true,"description":"Application name for which the events are to be retrieved.","schema":{"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","context_aware_access","chrome","data_studio","keep","classroom"],"type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"actorIpAddress","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"endTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"eventName","in":"query","required":false,"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`.","schema":{"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`.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","schema":{"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","type":"string"},"style":"form","explode":false},{"name":"groupIdFilter","in":"query","required":false,"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](https://support.google.com/a/answer/11482175)","schema":{"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](https://support.google.com/a/answer/11482175)","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitID","in":"query","required":false,"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.","schema":{"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.","default":"","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}},"/admin/reports/v1/usage/dates/{date}":{"get":{"operationId":"reports.customerUsageReports.get","x-executor-toolPath":"reports.customerUsageReports.get","tags":["Admin SDK API"],"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.","parameters":[{"name":"date","in":"path","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","schema":{"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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"},"style":"form","explode":false},{"name":"parameters","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_UsageReports"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}},"/admin/reports/v1/usage/users/{userKey}/dates/{date}":{"get":{"operationId":"reports.userUsageReport.get","x-executor-toolPath":"reports.userUsageReport.get","tags":["Admin SDK API"],"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.","parameters":[{"name":"userKey","in":"path","required":true,"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`.","schema":{"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`.","type":"string"}},{"name":"date","in":"path","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","schema":{"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=).","schema":{"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=).","type":"string"},"style":"form","explode":false},{"name":"groupIdFilter","in":"query","required":false,"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\"","schema":{"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\"","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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.","format":"uint32","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitID","in":"query","required":false,"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.","schema":{"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.","default":"","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"parameters","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_UsageReports"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}},"/admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}":{"get":{"operationId":"reports.entityUsageReports.get","x-executor-toolPath":"reports.entityUsageReports.get","tags":["Admin SDK API"],"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.","parameters":[{"name":"entityType","in":"path","required":true,"description":"Represents the type of entity for the report.","schema":{"description":"Represents the type of entity for the report.","enum":["gplus_communities"],"type":"string"}},{"name":"entityKey","in":"path","required":true,"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.","schema":{"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.","type":"string"}},{"name":"date","in":"path","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","schema":{"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.","schema":{"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"parameters","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_UsageReports"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}},"/admin/reports_v1/channels/stop":{"post":{"operationId":"admin.channels.stop","x-executor-toolPath":"admin.channels.stop","tags":["Admin SDK API"],"description":"Stop watching resources through this channel.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}}},"components":{"schemas":{"admin_reports_v1_Activities":{"description":"JSON template for a collection of activities.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"Each activity record in the response.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_Activity"}},"kind":{"description":"The type of API resource. For an activity report, the value is `reports#activities`.","default":"admin#reports#activities","type":"string"},"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"}}},"admin_reports_v1_Activity":{"description":"JSON template for the activity resource.","type":"object","properties":{"actor":{"description":"User doing the action.","type":"object","properties":{"agentAttributionInfo":{"$ref":"#/components/schemas/admin_reports_v1_AgentAttributionInfo"},"applicationInfo":{"description":"Details of the application that was the actor for the activity.","type":"object","properties":{"applicationName":{"description":"Name of the application used to perform the action.","type":"string"},"impersonation":{"description":"Whether the application was impersonating a user.","type":"boolean"},"oauthClientId":{"description":"OAuth client id of the third party application used to perform the action.","type":"string"}}},"callerType":{"description":"The type of actor.","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"},"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"},"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"}}},"etag":{"description":"ETag of the entry.","type":"string"},"events":{"description":"Activity events in the report.","type":"array","items":{"type":"object","properties":{"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":{"boolValue":{"description":"Boolean value of the parameter.","type":"boolean"},"intValue":{"description":"Integer value of the parameter.","format":"int64","type":"string"},"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":"#/components/schemas/admin_reports_v1_NestedParameter"}}}},"multiIntValue":{"description":"Integer values of the parameter.","type":"array","items":{"format":"int64","type":"string"}},"multiMessageValue":{"description":"List of `messageValue` objects.","type":"array","items":{"type":"object","properties":{"parameter":{"description":"Parameter values","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_NestedParameter"}}}}},"multiValue":{"description":"String values of the parameter.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the parameter.","type":"string"},"value":{"description":"String value of the parameter.","type":"string"}}}},"resourceIds":{"description":"Resource ids associated with the event.","type":"array","items":{"type":"string"}},"sensitiveParameters":{"description":"Includes sensitive parameter value pairs for various applications.","type":"array","items":{"type":"object","properties":{"boolValue":{"description":"Boolean value of the parameter.","type":"boolean"},"intValue":{"description":"Integer value of the parameter.","format":"int64","type":"string"},"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":"#/components/schemas/admin_reports_v1_NestedParameter"}}}},"multiIntValue":{"description":"Integer values of the parameter.","type":"array","items":{"format":"int64","type":"string"}},"multiMessageValue":{"description":"List of `messageValue` objects.","type":"array","items":{"type":"object","properties":{"parameter":{"description":"Parameter values","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_NestedParameter"}}}}},"multiValue":{"description":"String values of the parameter.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the parameter.","type":"string"},"value":{"description":"String value of the parameter.","type":"string"}}}},"status":{"$ref":"#/components/schemas/admin_reports_v1_ActivityEventsStatus"},"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"}}}},"id":{"description":"Unique identifier for each activity record.","type":"object","properties":{"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"},"time":{"description":"Time of occurrence of the activity. This is in UNIX epoch time in seconds.","format":"date-time","type":"string"},"uniqueQualifier":{"description":"Unique qualifier if multiple events have the same time.","format":"int64","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"},"isAgenticAction":{"description":"Whether the activity was performed by an agent.","type":"boolean"},"kind":{"description":"The type of API resource. For an activity report, the value is `audit#activity`.","default":"admin#reports#activity","type":"string"},"networkInfo":{"$ref":"#/components/schemas/admin_reports_v1_ActivityNetworkInfo"},"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"},"resourceDetails":{"description":"Details of the resource on which the action was performed.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_ResourceDetails"}},"userDeviceInfo":{"$ref":"#/components/schemas/admin_reports_v1_ActivityUserDeviceInfo"}}},"admin_reports_v1_ActivityEventsStatus":{"description":"Status of the event. Note: Not all events have status.","type":"object","properties":{"errorCode":{"description":"Error code of the event. Note: Field can be empty.","type":"string"},"errorMessage":{"description":"Error message of the event. Note: Field can be empty.","type":"string"},"eventStatus":{"description":"Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS - SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED ","type":"string"},"httpStatusCode":{"description":"Status code of the event. Note: Field can be empty.","format":"int32","type":"integer"}}},"admin_reports_v1_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":{"format":"int32","type":"integer"}},"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"}}},"admin_reports_v1_ActivityUserDeviceInfo":{"description":"Device details of the user doing the action.","type":"object","properties":{"deviceId":{"description":"Output only. Device ID of the user's device.","readOnly":true,"type":"string"},"deviceOsVersion":{"description":"Output only. Device OS version of the user's device.","readOnly":true,"type":"string"},"deviceType":{"description":"Output only. The type of the user's device.","readOnly":true,"type":"string"}}},"admin_reports_v1_AgentAttributionInfo":{"description":"Details of the AI agent that was the actor for the activity.","type":"object","properties":{"agentId":{"description":"The ID of the agent.","type":"string"},"agentName":{"description":"The user visible name of the agent.","type":"string"},"agentOwner":{"$ref":"#/components/schemas/admin_reports_v1_AgentAttributionInfoAgentOwner"},"agentType":{"description":"Type of the agent.","type":"string"}}},"admin_reports_v1_AgentAttributionInfoAgentOwner":{"description":"Details of the owner of the AI agent.","type":"object","properties":{"email":{"description":"The email of the agent owner.","type":"string"}}},"admin_reports_v1_AppliedLabel":{"description":"Details of the label applied on the resource.","type":"object","properties":{"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":"#/components/schemas/admin_reports_v1_FieldValue"}},"id":{"description":"Identifier of the label - Only the label id, not the full OnePlatform resource name.","type":"string"},"reason":{"$ref":"#/components/schemas/admin_reports_v1_Reason"},"title":{"description":"Title of the label","type":"string"}}},"admin_reports_v1_Channel":{"description":"A notification channel used to watch for resource changes.","type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional.","type":"object","additionalProperties":{"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"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel. The value should be set to `\"web_hook\"`.","type":"string"}}},"admin_reports_v1_CustomerIdentity":{"description":"Identity of the Google Workspace customer who owns the resource.","type":"object","properties":{"id":{"description":"Customer id.","type":"string"}}},"admin_reports_v1_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":{"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.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"admin_reports_v1_FieldValue":{"description":"Details of the field value set by the user for the particular label.","type":"object","properties":{"dateValue":{"$ref":"#/components/schemas/admin_reports_v1_Date"},"displayName":{"description":"Display name of the field","type":"string"},"id":{"description":"Identifier of the field","type":"string"},"integerValue":{"description":"Setting an integer value.","format":"int64","type":"string"},"longTextValue":{"description":"Setting a long text value.","type":"string"},"reason":{"$ref":"#/components/schemas/admin_reports_v1_Reason"},"selectionListValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueSelectionListValue"},"selectionValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueSelectionValue"},"textListValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueTextListValue"},"textValue":{"description":"Setting a text value.","type":"string"},"type":{"description":"Type of the field","type":"string"},"unsetValue":{"description":"If the field is unset, this will be true.","type":"boolean"},"userListValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueUserListValue"},"userValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueUserValue"}}},"admin_reports_v1_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":"#/components/schemas/admin_reports_v1_FieldValueSelectionValue"}}}},"admin_reports_v1_FieldValueSelectionValue":{"description":"Setting a selection value by selecting a single value from a dropdown.","type":"object","properties":{"badged":{"description":"Whether the selection is badged.","type":"boolean"},"displayName":{"description":"Display name of the selection.","type":"string"},"id":{"description":"Identifier of the selection.","type":"string"}}},"admin_reports_v1_FieldValueTextListValue":{"description":"Setting a text list value.","type":"object","properties":{"values":{"description":"List of text values.","type":"array","items":{"type":"string"}}}},"admin_reports_v1_FieldValueUserListValue":{"description":"Setting a user list value by selecting multiple users.","type":"object","properties":{"values":{"description":"List of users.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueUserValue"}}}},"admin_reports_v1_FieldValueUserValue":{"description":"Setting a user value by selecting a single user.","type":"object","properties":{"email":{"description":"Email of the user.","type":"string"}}},"admin_reports_v1_GroupIdentity":{"description":"Identity of the group who owns the resource.","type":"object","properties":{"groupEmail":{"description":"Group email.","type":"string"},"id":{"description":"Group gaia id.","type":"string"}}},"admin_reports_v1_NestedParameter":{"description":"JSON template for a parameter used in various reports.","type":"object","properties":{"boolValue":{"description":"Boolean value of the parameter.","type":"boolean"},"intValue":{"description":"Integer value of the parameter.","format":"int64","type":"string"},"multiBoolValue":{"description":"Multiple boolean values of the parameter.","type":"array","items":{"type":"boolean"}},"multiIntValue":{"description":"Multiple integer values of the parameter.","type":"array","items":{"format":"int64","type":"string"}},"multiValue":{"description":"Multiple string values of the parameter.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the parameter.","type":"string"},"value":{"description":"String value of the parameter.","type":"string"}}},"admin_reports_v1_OwnerDetails":{"description":"Details of the owner of the resource.","type":"object","properties":{"ownerIdentity":{"description":"Identity details of the owner(s) of the resource.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_OwnerIdentity"}},"ownerType":{"description":"Type of the owner of the resource.","type":"string"}}},"admin_reports_v1_OwnerIdentity":{"description":"Identity details of the owner of the resource.","type":"object","properties":{"customerIdentity":{"$ref":"#/components/schemas/admin_reports_v1_CustomerIdentity"},"groupIdentity":{"$ref":"#/components/schemas/admin_reports_v1_GroupIdentity"},"sharedDriveIdentity":{"$ref":"#/components/schemas/admin_reports_v1_SharedDriveIdentity"},"userIdentity":{"$ref":"#/components/schemas/admin_reports_v1_UserIdentity"}}},"admin_reports_v1_Reason":{"description":"The reason why the label/field was applied.","type":"object","properties":{"reasonType":{"description":"The type of the reason.","type":"string"}}},"admin_reports_v1_ResourceDetails":{"description":"Details of the resource on which the action was performed.","type":"object","properties":{"appliedLabels":{"description":"List of labels applied on the resource","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_AppliedLabel"}},"id":{"description":"Identifier of the resource, such as a doc_id for a Drive document, a conference_id for a Meet conference, or a \"gaia_id/rfc2822_message_id\" for an email.","type":"string"},"ownerDetails":{"$ref":"#/components/schemas/admin_reports_v1_OwnerDetails"},"relation":{"description":"Defines relationship of the resource to the events","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"}}},"admin_reports_v1_SharedDriveIdentity":{"description":"Identity of the shared drive who owns the resource.","type":"object","properties":{"id":{"description":"Shared drive gaia id.","type":"string"},"sharedDriveName":{"description":"Shared drive name.","type":"string"}}},"admin_reports_v1_UsageReport":{"description":"JSON template for a usage report.","type":"object","properties":{"date":{"description":"Output only. The date of the report request.","readOnly":true,"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"},"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"},"profileId":{"description":"Output only. The user's immutable Google Workspace profile identifier.","readOnly":true,"type":"string"},"type":{"description":"Output only. The type of item. The value is `user`.","readOnly":true,"type":"string"},"userEmail":{"description":"Output only. The user's email address. Only relevant if entity.type = \"USER\"","readOnly":true,"type":"string"}}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of API resource. For a usage report, the value is `admin#reports#usageReport`.","default":"admin#reports#usageReport","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](https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities).","readOnly":true,"type":"array","items":{"type":"object","properties":{"boolValue":{"description":"Output only. Boolean value of the parameter.","readOnly":true,"type":"boolean"},"datetimeValue":{"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":"Output only. Integer value of the parameter.","format":"int64","readOnly":true,"type":"string"},"msgValue":{"description":"Output only. Nested message value of the parameter.","readOnly":true,"type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object."}}},"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"}}}}}},"admin_reports_v1_UsageReports":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of API resource. For a usage report, the value is `admin#reports#usageReports`.","default":"admin#reports#usageReports","type":"string"},"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"},"usageReports":{"description":"Various application parameter records.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_UsageReport"}},"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"},"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"}}}},"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"}}}}}},"admin_reports_v1_UserIdentity":{"description":"Identity of the user who owns the resource.","type":"object","properties":{"id":{"description":"User gaia id.","type":"string"},"userEmail":{"description":"User email.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/admin.reports.audit.readonly":"","https://www.googleapis.com/auth/admin.reports.usage.readonly":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/admin.reports.audit.readonly","https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/admin/reports_v1/rest","service":"admin","version":"reports_v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Admin SDK API","version":"reports_v1","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."},"servers":[{"url":"https://admin.googleapis.com/"}],"paths":{"/admin/reports/v1/activity/users/{userKey}/applications/{applicationName}":{"get":{"operationId":"reports.activities.list","x-executor-toolPath":"reports.activities.list","tags":["Admin SDK API"],"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.","parameters":[{"name":"userKey","in":"path","required":true,"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`.","schema":{"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`.","type":"string"}},{"name":"applicationName","in":"path","required":true,"description":"Application name for which the events are to be retrieved.","schema":{"description":"Application name for which the events are to be retrieved.","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","voice","chrome_sync","workspace_studio","gemini_notebook"],"type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"actorIpAddress","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"agentInfoFilter","in":"query","required":false,"description":"Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example: \"agentInfoFilter=agentId=\\\"agent-id\\\" AND agentName=\\\"agent-name\\\" AND agentOwnerEmail=\\\"agent-owner-email\\\"\"","schema":{"description":"Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example: \"agentInfoFilter=agentId=\\\"agent-id\\\" AND agentName=\\\"agent-name\\\" AND agentOwnerEmail=\\\"agent-owner-email\\\"\"","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"applicationInfoFilter","in":"query","required":false,"description":"Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId=\"clientId\" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```","schema":{"description":"Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId=\"clientId\" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```","type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"deviceFilter","in":"query","required":false,"description":"Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and `deviceOsVersion`. **Usage** ``` GET...&deviceFilter=deviceId=\"123\" GET...&deviceFilter=deviceType=\"ANDROID\" GET...&deviceFilter=deviceOsVersion=\"14.0\" ```","schema":{"description":"Optional. Used to filter on the fields present in [`UserDeviceInfo`](#userdeviceinfo) message like `deviceId`, `deviceType`, and `deviceOsVersion`. **Usage** ``` GET...&deviceFilter=deviceId=\"123\" GET...&deviceFilter=deviceType=\"ANDROID\" GET...&deviceFilter=deviceOsVersion=\"14.0\" ```","type":"string"},"style":"form","explode":false},{"name":"endTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"eventName","in":"query","required":false,"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`.","schema":{"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`.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","schema":{"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","type":"string"},"style":"form","explode":false},{"name":"groupIdFilter","in":"query","required":false,"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](https://support.google.com/a/answer/11482175)","schema":{"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](https://support.google.com/a/answer/11482175)","type":"string"},"style":"form","explode":false},{"name":"includeSensitiveData","in":"query","required":false,"description":"Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter is supported only for Rules (DLP), Chat and Workspace Studio applications; using it with any other application will result in a permission error.","schema":{"description":"Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter is supported only for Rules (DLP), Chat and Workspace Studio applications; using it with any other application will result in a permission error.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"networkInfoFilter","in":"query","required":false,"description":"Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode=\"IN\" GET...&networkInfoFilter=regionCode=%22IN%22 ```","schema":{"description":"Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode=\"IN\" GET...&networkInfoFilter=regionCode=%22IN%22 ```","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitID","in":"query","required":false,"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.","schema":{"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.","default":"","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"resourceDetailsFilter","in":"query","required":false,"description":"Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) 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`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#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`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#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`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported.","schema":{"description":"Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) 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`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#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`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#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`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported.","type":"string"},"style":"form","explode":false},{"name":"startTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"statusFilter","in":"query","required":false,"description":"Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode=\"200\" GET...&statusFilter=statusCode=%22200%22 ```","schema":{"description":"Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode=\"200\" GET...&statusFilter=statusCode=%22200%22 ```","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Activities"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}},"/admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch":{"post":{"operationId":"reports.activities.watch","x-executor-toolPath":"reports.activities.watch","tags":["Admin SDK API"],"description":"Start receiving notifications for account activities. For more information, see Receiving Push Notifications.","parameters":[{"name":"userKey","in":"path","required":true,"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`.","schema":{"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`.","type":"string"}},{"name":"applicationName","in":"path","required":true,"description":"Application name for which the events are to be retrieved.","schema":{"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","context_aware_access","chrome","data_studio","keep","classroom"],"type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"actorIpAddress","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"endTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"eventName","in":"query","required":false,"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`.","schema":{"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`.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","schema":{"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](#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 `<>` 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'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'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.","type":"string"},"style":"form","explode":false},{"name":"groupIdFilter","in":"query","required":false,"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](https://support.google.com/a/answer/11482175)","schema":{"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](https://support.google.com/a/answer/11482175)","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitID","in":"query","required":false,"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.","schema":{"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.","default":"","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startTime","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}},"/admin/reports/v1/usage/dates/{date}":{"get":{"operationId":"reports.customerUsageReports.get","x-executor-toolPath":"reports.customerUsageReports.get","tags":["Admin SDK API"],"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.","parameters":[{"name":"date","in":"path","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","schema":{"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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"},"style":"form","explode":false},{"name":"parameters","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_UsageReports"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}},"/admin/reports/v1/usage/users/{userKey}/dates/{date}":{"get":{"operationId":"reports.userUsageReport.get","x-executor-toolPath":"reports.userUsageReport.get","tags":["Admin SDK API"],"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.","parameters":[{"name":"userKey","in":"path","required":true,"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`.","schema":{"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`.","type":"string"}},{"name":"date","in":"path","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","schema":{"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=).","schema":{"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=).","type":"string"},"style":"form","explode":false},{"name":"groupIdFilter","in":"query","required":false,"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\"","schema":{"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\"","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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.","format":"uint32","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orgUnitID","in":"query","required":false,"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.","schema":{"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.","default":"","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"parameters","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_UsageReports"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}},"/admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}":{"get":{"operationId":"reports.entityUsageReports.get","x-executor-toolPath":"reports.entityUsageReports.get","tags":["Admin SDK API"],"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.","parameters":[{"name":"entityType","in":"path","required":true,"description":"Represents the type of entity for the report.","schema":{"description":"Represents the type of entity for the report.","enum":["gplus_communities"],"type":"string"}},{"name":"entityKey","in":"path","required":true,"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.","schema":{"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.","type":"string"}},{"name":"date","in":"path","required":true,"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","schema":{"description":"Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"customerId","in":"query","required":false,"description":"The unique ID of the customer to retrieve data for.","schema":{"description":"The unique ID of the customer to retrieve data for.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filters","in":"query","required":false,"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.","schema":{"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 `<>` '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'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"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.","schema":{"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","default":1000,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"parameters","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_UsageReports"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.usage.readonly"]}},"/admin/reports_v1/channels/stop":{"post":{"operationId":"admin.channels.stop","x-executor-toolPath":"admin.channels.stop","tags":["Admin SDK API"],"description":"Stop watching resources through this channel.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_reports_v1_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/admin.reports.audit.readonly"]}}},"components":{"schemas":{"admin_reports_v1_Activities":{"description":"JSON template for a collection of activities.","type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"Each activity record in the response.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_Activity"}},"kind":{"description":"The type of API resource. For an activity report, the value is `reports#activities`.","default":"admin#reports#activities","type":"string"},"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"}}},"admin_reports_v1_Activity":{"description":"JSON template for the activity resource.","type":"object","properties":{"actor":{"description":"User doing the action.","type":"object","properties":{"agentAttributionInfo":{"$ref":"#/components/schemas/admin_reports_v1_AgentAttributionInfo"},"applicationInfo":{"description":"Details of the application that was the actor for the activity.","type":"object","properties":{"applicationName":{"description":"Name of the application used to perform the action.","type":"string"},"impersonation":{"description":"Whether the application was impersonating a user.","type":"boolean"},"oauthClientId":{"description":"OAuth client id of the third party application used to perform the action.","type":"string"}}},"callerType":{"description":"The type of actor.","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"},"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"},"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"}}},"etag":{"description":"ETag of the entry.","type":"string"},"events":{"description":"Activity events in the report.","type":"array","items":{"type":"object","properties":{"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":{"boolValue":{"description":"Boolean value of the parameter.","type":"boolean"},"intValue":{"description":"Integer value of the parameter.","format":"int64","type":"string"},"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":"#/components/schemas/admin_reports_v1_NestedParameter"}}}},"multiIntValue":{"description":"Integer values of the parameter.","type":"array","items":{"format":"int64","type":"string"}},"multiMessageValue":{"description":"List of `messageValue` objects.","type":"array","items":{"type":"object","properties":{"parameter":{"description":"Parameter values","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_NestedParameter"}}}}},"multiValue":{"description":"String values of the parameter.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the parameter.","type":"string"},"value":{"description":"String value of the parameter.","type":"string"}}}},"resourceIds":{"description":"Resource ids associated with the event.","type":"array","items":{"type":"string"}},"sensitiveParameters":{"description":"Includes sensitive parameter value pairs for various applications.","type":"array","items":{"type":"object","properties":{"boolValue":{"description":"Boolean value of the parameter.","type":"boolean"},"intValue":{"description":"Integer value of the parameter.","format":"int64","type":"string"},"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":"#/components/schemas/admin_reports_v1_NestedParameter"}}}},"multiIntValue":{"description":"Integer values of the parameter.","type":"array","items":{"format":"int64","type":"string"}},"multiMessageValue":{"description":"List of `messageValue` objects.","type":"array","items":{"type":"object","properties":{"parameter":{"description":"Parameter values","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_NestedParameter"}}}}},"multiValue":{"description":"String values of the parameter.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the parameter.","type":"string"},"value":{"description":"String value of the parameter.","type":"string"}}}},"status":{"$ref":"#/components/schemas/admin_reports_v1_ActivityEventsStatus"},"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"}}}},"id":{"description":"Unique identifier for each activity record.","type":"object","properties":{"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"},"time":{"description":"Time of occurrence of the activity. This is in UNIX epoch time in seconds.","format":"date-time","type":"string"},"uniqueQualifier":{"description":"Unique qualifier if multiple events have the same time.","format":"int64","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"},"isAgenticAction":{"description":"Whether the activity was performed by an agent.","type":"boolean"},"kind":{"description":"The type of API resource. For an activity report, the value is `audit#activity`.","default":"admin#reports#activity","type":"string"},"networkInfo":{"$ref":"#/components/schemas/admin_reports_v1_ActivityNetworkInfo"},"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"},"resourceDetails":{"description":"Details of the resource on which the action was performed.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_ResourceDetails"}},"userDeviceInfo":{"$ref":"#/components/schemas/admin_reports_v1_ActivityUserDeviceInfo"}}},"admin_reports_v1_ActivityEventsStatus":{"description":"Status of the event. Note: Not all events have status.","type":"object","properties":{"errorCode":{"description":"Error code of the event. Note: Field can be empty.","type":"string"},"errorMessage":{"description":"Error message of the event. Note: Field can be empty.","type":"string"},"eventStatus":{"description":"Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS - SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED ","type":"string"},"httpStatusCode":{"description":"Status code of the event. Note: Field can be empty.","format":"int32","type":"integer"}}},"admin_reports_v1_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":{"format":"int32","type":"integer"}},"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"}}},"admin_reports_v1_ActivityUserDeviceInfo":{"description":"Device details of the user doing the action.","type":"object","properties":{"deviceId":{"description":"Output only. Device ID of the user's device.","readOnly":true,"type":"string"},"deviceOsVersion":{"description":"Output only. Device OS version of the user's device.","readOnly":true,"type":"string"},"deviceType":{"description":"Output only. The type of the user's device.","readOnly":true,"type":"string"}}},"admin_reports_v1_AgentAttributionInfo":{"description":"Details of the AI agent that was the actor for the activity.","type":"object","properties":{"agentId":{"description":"The ID of the agent.","type":"string"},"agentName":{"description":"The user visible name of the agent.","type":"string"},"agentOwner":{"$ref":"#/components/schemas/admin_reports_v1_AgentAttributionInfoAgentOwner"},"agentType":{"description":"Type of the agent.","type":"string"}}},"admin_reports_v1_AgentAttributionInfoAgentOwner":{"description":"Details of the owner of the AI agent.","type":"object","properties":{"email":{"description":"The email of the agent owner.","type":"string"}}},"admin_reports_v1_AppliedLabel":{"description":"Details of the label applied on the resource.","type":"object","properties":{"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":"#/components/schemas/admin_reports_v1_FieldValue"}},"id":{"description":"Identifier of the label - Only the label id, not the full OnePlatform resource name.","type":"string"},"reason":{"$ref":"#/components/schemas/admin_reports_v1_Reason"},"title":{"description":"Title of the label","type":"string"}}},"admin_reports_v1_Channel":{"description":"A notification channel used to watch for resource changes.","type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional.","type":"object","additionalProperties":{"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"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel. The value should be set to `\"web_hook\"`.","type":"string"}}},"admin_reports_v1_CustomerIdentity":{"description":"Identity of the Google Workspace customer who owns the resource.","type":"object","properties":{"id":{"description":"Customer id.","type":"string"}}},"admin_reports_v1_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":{"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.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"admin_reports_v1_FieldValue":{"description":"Details of the field value set by the user for the particular label.","type":"object","properties":{"dateValue":{"$ref":"#/components/schemas/admin_reports_v1_Date"},"displayName":{"description":"Display name of the field","type":"string"},"id":{"description":"Identifier of the field","type":"string"},"integerValue":{"description":"Setting an integer value.","format":"int64","type":"string"},"longTextValue":{"description":"Setting a long text value.","type":"string"},"reason":{"$ref":"#/components/schemas/admin_reports_v1_Reason"},"selectionListValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueSelectionListValue"},"selectionValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueSelectionValue"},"textListValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueTextListValue"},"textValue":{"description":"Setting a text value.","type":"string"},"type":{"description":"Type of the field","type":"string"},"unsetValue":{"description":"If the field is unset, this will be true.","type":"boolean"},"userListValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueUserListValue"},"userValue":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueUserValue"}}},"admin_reports_v1_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":"#/components/schemas/admin_reports_v1_FieldValueSelectionValue"}}}},"admin_reports_v1_FieldValueSelectionValue":{"description":"Setting a selection value by selecting a single value from a dropdown.","type":"object","properties":{"badged":{"description":"Whether the selection is badged.","type":"boolean"},"displayName":{"description":"Display name of the selection.","type":"string"},"id":{"description":"Identifier of the selection.","type":"string"}}},"admin_reports_v1_FieldValueTextListValue":{"description":"Setting a text list value.","type":"object","properties":{"values":{"description":"List of text values.","type":"array","items":{"type":"string"}}}},"admin_reports_v1_FieldValueUserListValue":{"description":"Setting a user list value by selecting multiple users.","type":"object","properties":{"values":{"description":"List of users.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_FieldValueUserValue"}}}},"admin_reports_v1_FieldValueUserValue":{"description":"Setting a user value by selecting a single user.","type":"object","properties":{"email":{"description":"Email of the user.","type":"string"}}},"admin_reports_v1_GroupIdentity":{"description":"Identity of the group who owns the resource.","type":"object","properties":{"groupEmail":{"description":"Group email.","type":"string"},"id":{"description":"Group gaia id.","type":"string"}}},"admin_reports_v1_NestedParameter":{"description":"JSON template for a parameter used in various reports.","type":"object","properties":{"boolValue":{"description":"Boolean value of the parameter.","type":"boolean"},"intValue":{"description":"Integer value of the parameter.","format":"int64","type":"string"},"multiBoolValue":{"description":"Multiple boolean values of the parameter.","type":"array","items":{"type":"boolean"}},"multiIntValue":{"description":"Multiple integer values of the parameter.","type":"array","items":{"format":"int64","type":"string"}},"multiValue":{"description":"Multiple string values of the parameter.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the parameter.","type":"string"},"value":{"description":"String value of the parameter.","type":"string"}}},"admin_reports_v1_OwnerDetails":{"description":"Details of the owner of the resource.","type":"object","properties":{"ownerIdentity":{"description":"Identity details of the owner(s) of the resource.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_OwnerIdentity"}},"ownerType":{"description":"Type of the owner of the resource.","type":"string"}}},"admin_reports_v1_OwnerIdentity":{"description":"Identity details of the owner of the resource.","type":"object","properties":{"customerIdentity":{"$ref":"#/components/schemas/admin_reports_v1_CustomerIdentity"},"groupIdentity":{"$ref":"#/components/schemas/admin_reports_v1_GroupIdentity"},"sharedDriveIdentity":{"$ref":"#/components/schemas/admin_reports_v1_SharedDriveIdentity"},"userIdentity":{"$ref":"#/components/schemas/admin_reports_v1_UserIdentity"}}},"admin_reports_v1_Reason":{"description":"The reason why the label/field was applied.","type":"object","properties":{"reasonType":{"description":"The type of the reason.","type":"string"}}},"admin_reports_v1_ResourceDetails":{"description":"Details of the resource on which the action was performed.","type":"object","properties":{"appliedLabels":{"description":"List of labels applied on the resource","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_AppliedLabel"}},"id":{"description":"Identifier of the resource, such as a doc_id for a Drive document, a conference_id for a Meet conference, or a \"gaia_id/rfc2822_message_id\" for an email.","type":"string"},"ownerDetails":{"$ref":"#/components/schemas/admin_reports_v1_OwnerDetails"},"relation":{"description":"Defines relationship of the resource to the events","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"}}},"admin_reports_v1_SharedDriveIdentity":{"description":"Identity of the shared drive who owns the resource.","type":"object","properties":{"id":{"description":"Shared drive gaia id.","type":"string"},"sharedDriveName":{"description":"Shared drive name.","type":"string"}}},"admin_reports_v1_UsageReport":{"description":"JSON template for a usage report.","type":"object","properties":{"date":{"description":"Output only. The date of the report request.","readOnly":true,"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"},"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"},"profileId":{"description":"Output only. The user's immutable Google Workspace profile identifier.","readOnly":true,"type":"string"},"type":{"description":"Output only. The type of item. The value is `user`.","readOnly":true,"type":"string"},"userEmail":{"description":"Output only. The user's email address. Only relevant if entity.type = \"USER\"","readOnly":true,"type":"string"}}},"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of API resource. For a usage report, the value is `admin#reports#usageReport`.","default":"admin#reports#usageReport","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](https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities).","readOnly":true,"type":"array","items":{"type":"object","properties":{"boolValue":{"description":"Output only. Boolean value of the parameter.","readOnly":true,"type":"boolean"},"datetimeValue":{"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":"Output only. Integer value of the parameter.","format":"int64","readOnly":true,"type":"string"},"msgValue":{"description":"Output only. Nested message value of the parameter.","readOnly":true,"type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object."}}},"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"}}}}}},"admin_reports_v1_UsageReports":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"kind":{"description":"The type of API resource. For a usage report, the value is `admin#reports#usageReports`.","default":"admin#reports#usageReports","type":"string"},"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"},"usageReports":{"description":"Various application parameter records.","type":"array","items":{"$ref":"#/components/schemas/admin_reports_v1_UsageReport"}},"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"},"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"}}}},"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"}}}}}},"admin_reports_v1_UserIdentity":{"description":"Identity of the user who owns the resource.","type":"object","properties":{"id":{"description":"User gaia id.","type":"string"},"userEmail":{"description":"User email.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/admin.reports.audit.readonly":"View audit reports for your Google Workspace domain","https://www.googleapis.com/auth/admin.reports.usage.readonly":"View usage reports for your Google Workspace domain"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/admin.reports.audit.readonly","https://www.googleapis.com/auth/admin.reports.usage.readonly"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/admin/reports_v1/rest","service":"admin","version":"reports_v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-apps-script.json b/public/specs/google/google-apps-script.json index e4f8cde2..722c661a 100644 --- a/public/specs/google/google-apps-script.json +++ b/public/specs/google/google-apps-script.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Apps Script API","version":"v1","description":"Manages and executes Google Apps Script projects. "},"servers":[{"url":"https://script.googleapis.com/"}],"paths":{"/v1/processes":{"get":{"operationId":"script.processes.list","x-executor-toolPath":"script.processes.list","tags":["Apps Script API"],"description":"List information about processes made by or on behalf of a user, such as process type and current status.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of returned processes per page of results. Defaults to 50.","schema":{"description":"The maximum number of returned processes per page of results. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.deploymentId","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.endTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.functionName","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","schema":{"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.projectName","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with project names containing a specific string.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with project names containing a specific string.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.scriptId","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with a specific script ID.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with a specific script ID.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.startTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.statuses","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","enum":["PROCESS_STATUS_UNSPECIFIED","RUNNING","PAUSED","COMPLETED","CANCELED","FAILED","TIMED_OUT","UNKNOWN","DELAYED","EXECUTION_DISABLED"],"type":"string"}},"style":"form","explode":true},{"name":"userProcessFilter.types","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process types.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process types.","enum":["PROCESS_TYPE_UNSPECIFIED","ADD_ON","EXECUTION_API","TIME_DRIVEN","TRIGGER","WEBAPP","EDITOR","SIMPLE_TRIGGER","MENU","BATCH_TASK"],"type":"string"}},"style":"form","explode":true},{"name":"userProcessFilter.userAccessLevels","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","enum":["USER_ACCESS_LEVEL_UNSPECIFIED","NONE","READ","WRITE","OWNER"],"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListUserProcessesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.processes"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.processes"]}},"/v1/processes:listScriptProcesses":{"get":{"operationId":"script.processes.listScriptProcesses","x-executor-toolPath":"script.processes.listScriptProcesses","tags":["Apps Script API"],"description":"List information about a script's executed processes, such as process type and current status.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of returned processes per page of results. Defaults to 50.","schema":{"description":"The maximum number of returned processes per page of results. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"scriptId","in":"query","required":false,"description":"The script ID of the project whose processes are listed.","schema":{"description":"The script ID of the project whose processes are listed.","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.deploymentId","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.endTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.functionName","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","schema":{"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.startTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.statuses","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","enum":["PROCESS_STATUS_UNSPECIFIED","RUNNING","PAUSED","COMPLETED","CANCELED","FAILED","TIMED_OUT","UNKNOWN","DELAYED","EXECUTION_DISABLED"],"type":"string"}},"style":"form","explode":true},{"name":"scriptProcessFilter.types","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process types.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process types.","enum":["PROCESS_TYPE_UNSPECIFIED","ADD_ON","EXECUTION_API","TIME_DRIVEN","TRIGGER","WEBAPP","EDITOR","SIMPLE_TRIGGER","MENU","BATCH_TASK"],"type":"string"}},"style":"form","explode":true},{"name":"scriptProcessFilter.userAccessLevels","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","enum":["USER_ACCESS_LEVEL_UNSPECIFIED","NONE","READ","WRITE","OWNER"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListScriptProcessesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.processes"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.processes"]}},"/v1/projects":{"post":{"operationId":"script.projects.create","x-executor-toolPath":"script.projects.create","tags":["Apps Script API"],"description":"Creates a new, empty script project with no script files and a base manifest file.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_CreateProjectRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Project"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}":{"get":{"operationId":"script.projects.get","x-executor-toolPath":"script.projects.get","tags":["Apps Script API"],"description":"Gets a script project's metadata.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Project"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}/content":{"get":{"operationId":"script.projects.getContent","x-executor-toolPath":"script.projects.getContent","tags":["Apps Script API"],"description":"Gets the content of the script project, including the code source and metadata for each script file.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"versionNumber","in":"query","required":false,"description":"The version number of the project to retrieve. If not provided, the project's HEAD version is returned.","schema":{"description":"The version number of the project to retrieve. If not provided, the project's HEAD version is returned.","format":"int32","type":"integer"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Content"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]},"put":{"operationId":"script.projects.updateContent","x-executor-toolPath":"script.projects.updateContent","tags":["Apps Script API"],"description":"Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Content"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Content"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}/deployments":{"get":{"operationId":"script.projects.deployments.list","x-executor-toolPath":"script.projects.deployments.list","tags":["Apps Script API"],"description":"Lists the deployments of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of deployments on each returned page. Defaults to 50.","schema":{"description":"The maximum number of deployments on each returned page. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListDeploymentsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]},"post":{"operationId":"script.projects.deployments.create","x-executor-toolPath":"script.projects.deployments.create","tags":["Apps Script API"],"description":"Creates a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_DeploymentConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Deployment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]}},"/v1/projects/{scriptId}/deployments/{deploymentId}":{"get":{"operationId":"script.projects.deployments.get","x-executor-toolPath":"script.projects.deployments.get","tags":["Apps Script API"],"description":"Gets a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID.","schema":{"description":"The deployment ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Deployment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]},"put":{"operationId":"script.projects.deployments.update","x-executor-toolPath":"script.projects.deployments.update","tags":["Apps Script API"],"description":"Updates a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID for this deployment.","schema":{"description":"The deployment ID for this deployment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_UpdateDeploymentRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Deployment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]},"delete":{"operationId":"script.projects.deployments.delete","x-executor-toolPath":"script.projects.deployments.delete","tags":["Apps Script API"],"description":"Deletes a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID to be undeployed.","schema":{"description":"The deployment ID to be undeployed.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]}},"/v1/projects/{scriptId}/metrics":{"get":{"operationId":"script.projects.getMetrics","x-executor-toolPath":"script.projects.getMetrics","tags":["Apps Script API"],"description":"Get metrics data for scripts, such as number of executions and active users.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"Required field indicating the script to get metrics for.","schema":{"description":"Required field indicating the script to get metrics for.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"metricsFilter.deploymentId","in":"query","required":false,"description":"Optional field indicating a specific deployment to retrieve metrics from.","schema":{"description":"Optional field indicating a specific deployment to retrieve metrics from.","type":"string"},"style":"form","explode":false},{"name":"metricsGranularity","in":"query","required":false,"description":"Required field indicating what granularity of metrics are returned.","schema":{"description":"Required field indicating what granularity of metrics are returned.","enum":["UNSPECIFIED_GRANULARITY","WEEKLY","DAILY"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Metrics"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.metrics"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.metrics"]}},"/v1/projects/{scriptId}/versions":{"get":{"operationId":"script.projects.versions.list","x-executor-toolPath":"script.projects.versions.list","tags":["Apps Script API"],"description":"List the versions of a script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of versions on each returned page. Defaults to 50.","schema":{"description":"The maximum number of versions on each returned page. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListVersionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]},"post":{"operationId":"script.projects.versions.create","x-executor-toolPath":"script.projects.versions.create","tags":["Apps Script API"],"description":"Creates a new immutable version using the current code, with a unique version number.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Version"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Version"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}/versions/{versionNumber}":{"get":{"operationId":"script.projects.versions.get","x-executor-toolPath":"script.projects.versions.get","tags":["Apps Script API"],"description":"Gets a version of a script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"versionNumber","in":"path","required":true,"description":"The version number.","schema":{"description":"The version number.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Version"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}}},"components":{"schemas":{"script_v1_Content":{"description":"The Content resource.","type":"object","properties":{"files":{"description":"The list of script project files. One of the files is a script manifest; it must be named \"appsscript\", must have type of JSON, and include the manifest configurations for the project.","type":"array","items":{"$ref":"#/components/schemas/script_v1_File"}},"scriptId":{"description":"The script project's Drive ID.","type":"string"}}},"script_v1_CreateProjectRequest":{"description":"Request to create a script project.","type":"object","properties":{"parentId":{"description":"The Drive ID of a parent file that the created script project is bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google Slides file. If not set, a standalone script project is created.","type":"string"},"title":{"description":"The title for the project.","type":"string"}}},"script_v1_Deployment":{"description":"Representation of a single script deployment.","type":"object","properties":{"deploymentConfig":{"$ref":"#/components/schemas/script_v1_DeploymentConfig"},"deploymentId":{"description":"The deployment ID for this deployment.","type":"string"},"entryPoints":{"description":"The deployment's entry points.","type":"array","items":{"$ref":"#/components/schemas/script_v1_EntryPoint"}},"updateTime":{"description":"Last modified date time stamp.","format":"google-datetime","type":"string"}}},"script_v1_DeploymentConfig":{"description":"Metadata the defines how a deployment is configured.","type":"object","properties":{"description":{"description":"The description for this deployment.","type":"string"},"manifestFileName":{"description":"The manifest file name for this deployment.","type":"string"},"scriptId":{"description":"The script project's Drive ID.","type":"string"},"versionNumber":{"description":"The version number on which this deployment is based.","format":"int32","type":"integer"}}},"script_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"script_v1_EntryPoint":{"description":"A configuration that defines how a deployment is accessed externally.","type":"object","properties":{"addOn":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeAddOnEntryPoint"},"entryPointType":{"description":"The type of the entry point.","enum":["ENTRY_POINT_TYPE_UNSPECIFIED","WEB_APP","EXECUTION_API","ADD_ON"],"type":"string"},"executionApi":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeExecutionApiEntryPoint"},"webApp":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeWebAppEntryPoint"}}},"script_v1_ExecutionError":{"description":"An object that provides information about the nature of an error resulting from an attempted execution of a script function using the Apps Script API. If a run call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains a Status object. The `Status` object's `details` field contains an array with a single one of these `ExecutionError` objects.","type":"object","properties":{"errorMessage":{"description":"The error message thrown by Apps Script, usually localized into the user's language.","type":"string"},"errorType":{"description":"The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included.","type":"string"},"scriptStackTraceElements":{"description":"An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.","type":"array","items":{"$ref":"#/components/schemas/script_v1_ScriptStackTraceElement"}}}},"script_v1_ExecutionRequest":{"description":"A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script returns results based on the implementation of the script.","type":"object","properties":{"devMode":{"description":"If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Apps Script API. Optional; default is `false`.","type":"boolean"},"function":{"description":"The name of the function to execute in the given script. The name does not include parentheses or parameters. It can reference a function in an included library such as `Library.libFunction1`.","type":"string"},"parameters":{"description":"The parameters to be passed to the function being executed. The object type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific object types (such as a `Document` or a `Calendar`); they can only be primitive types such as `string`, `number`, `array`, `object`, or `boolean`. Optional.","type":"array","items":{}},"sessionState":{"description":"*Deprecated*. For use with Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the [Intent](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/bound) script—that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`. Optional.","type":"string"}}},"script_v1_ExecutionResponse":{"description":"An object that provides the return value of a function executed using the Apps Script API. If the script function returns successfully, the response body's response field contains this `ExecutionResponse` object.","type":"object","properties":{"result":{"description":"The return value of the script function. The type matches the object type returned in Apps Script. Functions called using the Apps Script API cannot return Apps Script-specific objects (such as a `Document` or a `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`."}}},"script_v1_File":{"description":"An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.","type":"object","properties":{"createTime":{"description":"Creation date timestamp.","format":"google-datetime","type":"string"},"functionSet":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeFunctionSet"},"lastModifyUser":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeUser"},"name":{"description":"The name of the file. The file extension is not part of the file name, which can be identified from the type field.","type":"string"},"source":{"description":"The file content.","type":"string"},"type":{"description":"The type of the file.","enum":["ENUM_TYPE_UNSPECIFIED","SERVER_JS","HTML","JSON"],"type":"string"},"updateTime":{"description":"Last modified date timestamp.","format":"google-datetime","type":"string"}}},"script_v1_GoogleAppsScriptTypeAddOnEntryPoint":{"description":"An add-on entry point.","type":"object","properties":{"addOnType":{"description":"The add-on's required list of supported container types.","enum":["UNKNOWN_ADDON_TYPE","GMAIL","DATA_STUDIO"],"type":"string"},"description":{"description":"The add-on's optional description.","type":"string"},"helpUrl":{"description":"The add-on's optional help URL.","type":"string"},"postInstallTipUrl":{"description":"The add-on's required post install tip URL.","type":"string"},"reportIssueUrl":{"description":"The add-on's optional report issue URL.","type":"string"},"title":{"description":"The add-on's required title.","type":"string"}}},"script_v1_GoogleAppsScriptTypeExecutionApiConfig":{"description":"API executable entry point configuration.","type":"object","properties":{"access":{"description":"Who has permission to run the API executable.","enum":["UNKNOWN_ACCESS","MYSELF","DOMAIN","ANYONE","ANYONE_ANONYMOUS"],"type":"string"}}},"script_v1_GoogleAppsScriptTypeExecutionApiEntryPoint":{"description":"An API executable entry point.","type":"object","properties":{"entryPointConfig":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeExecutionApiConfig"}}},"script_v1_GoogleAppsScriptTypeFunction":{"description":"Represents a function in a script project.","type":"object","properties":{"name":{"description":"The function name in the script project.","type":"string"},"parameters":{"description":"The ordered list of parameter names of the function in the script project.","type":"array","items":{"type":"string"}}}},"script_v1_GoogleAppsScriptTypeFunctionSet":{"description":"A set of functions. No duplicates are permitted.","type":"object","properties":{"values":{"description":"A list of functions composing the set.","type":"array","items":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeFunction"}}}},"script_v1_GoogleAppsScriptTypeProcess":{"description":"Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API.","type":"object","properties":{"duration":{"description":"Duration the execution spent executing.","format":"google-duration","type":"string"},"functionName":{"description":"Name of the function the started the execution.","type":"string"},"processStatus":{"description":"The executions status.","enum":["PROCESS_STATUS_UNSPECIFIED","RUNNING","PAUSED","COMPLETED","CANCELED","FAILED","TIMED_OUT","UNKNOWN","DELAYED","EXECUTION_DISABLED"],"type":"string"},"processType":{"description":"The executions type.","enum":["PROCESS_TYPE_UNSPECIFIED","ADD_ON","EXECUTION_API","TIME_DRIVEN","TRIGGER","WEBAPP","EDITOR","SIMPLE_TRIGGER","MENU","BATCH_TASK"],"type":"string"},"projectName":{"description":"Name of the script being executed.","type":"string"},"runtimeVersion":{"description":"Which version of maestro to use to execute the script.","enum":["RUNTIME_VERSION_UNSPECIFIED","DEPRECATED_ES5","V8"],"type":"string"},"startTime":{"description":"Time the execution started.","format":"google-datetime","type":"string"},"userAccessLevel":{"description":"The executing users access level to the script.","enum":["USER_ACCESS_LEVEL_UNSPECIFIED","NONE","READ","WRITE","OWNER"],"type":"string"}}},"script_v1_GoogleAppsScriptTypeUser":{"description":"A simple user profile resource.","type":"object","properties":{"domain":{"description":"The user's domain.","type":"string"},"email":{"description":"The user's identifying email address.","type":"string"},"name":{"description":"The user's display name.","type":"string"},"photoUrl":{"description":"The user's photo.","type":"string"}}},"script_v1_GoogleAppsScriptTypeWebAppConfig":{"description":"Web app entry point configuration.","type":"object","properties":{"access":{"description":"Who has permission to run the web app.","enum":["UNKNOWN_ACCESS","MYSELF","DOMAIN","ANYONE","ANYONE_ANONYMOUS"],"type":"string"},"executeAs":{"description":"Who to execute the web app as.","enum":["UNKNOWN_EXECUTE_AS","USER_ACCESSING","USER_DEPLOYING"],"type":"string"}}},"script_v1_GoogleAppsScriptTypeWebAppEntryPoint":{"description":"A web application entry point.","type":"object","properties":{"entryPointConfig":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeWebAppConfig"},"url":{"description":"The URL for the web application.","type":"string"}}},"script_v1_ListDeploymentsResponse":{"description":"Response with the list of deployments for the specified Apps Script project.","type":"object","properties":{"deployments":{"description":"The list of deployments.","type":"array","items":{"$ref":"#/components/schemas/script_v1_Deployment"}},"nextPageToken":{"description":"The token that can be used in the next call to get the next page of results.","type":"string"}}},"script_v1_ListScriptProcessesResponse":{"description":"Response with the list of Process resources.","type":"object","properties":{"nextPageToken":{"description":"Token for the next page of results. If empty, there are no more pages remaining.","type":"string"},"processes":{"description":"List of processes matching request parameters.","type":"array","items":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeProcess"}}}},"script_v1_ListUserProcessesResponse":{"description":"Response with the list of Process resources.","type":"object","properties":{"nextPageToken":{"description":"Token for the next page of results. If empty, there are no more pages remaining.","type":"string"},"processes":{"description":"List of processes matching request parameters.","type":"array","items":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeProcess"}}}},"script_v1_ListVersionsResponse":{"description":"Response with the list of the versions for the specified script project.","type":"object","properties":{"nextPageToken":{"description":"The token use to fetch the next page of records. if not exist in the response, that means no more versions to list.","type":"string"},"versions":{"description":"The list of versions.","type":"array","items":{"$ref":"#/components/schemas/script_v1_Version"}}}},"script_v1_Metrics":{"description":"Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.","type":"object","properties":{"activeUsers":{"description":"Number of active users.","type":"array","items":{"$ref":"#/components/schemas/script_v1_MetricsValue"}},"failedExecutions":{"description":"Number of failed executions.","type":"array","items":{"$ref":"#/components/schemas/script_v1_MetricsValue"}},"totalExecutions":{"description":"Number of total executions.","type":"array","items":{"$ref":"#/components/schemas/script_v1_MetricsValue"}}}},"script_v1_MetricsValue":{"description":"Metrics value that holds number of executions counted.","type":"object","properties":{"endTime":{"description":"Required field indicating the end time of the interval.","format":"google-datetime","type":"string"},"startTime":{"description":"Required field indicating the start time of the interval.","format":"google-datetime","type":"string"},"value":{"description":"Indicates the number of executions counted.","format":"uint64","type":"string"}}},"script_v1_Operation":{"description":"A representation of an execution of an Apps Script function started with run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). After execution has started, it can have one of four outcomes: - If the script function returns successfully, the response field contains an ExecutionResponse object with the function's return value in the object's `result` field. - If the script function (or Apps Script itself) throws an exception, the error field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error. - If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present. - If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries automatically convert a 4XX response into an exception class. ","type":"object","properties":{"done":{"description":"This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed.","type":"boolean"},"error":{"$ref":"#/components/schemas/script_v1_Status"},"response":{"description":"If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}}},"script_v1_Project":{"description":"The script project resource.","type":"object","properties":{"createTime":{"description":"When the script was created.","format":"google-datetime","type":"string"},"creator":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeUser"},"lastModifyUser":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeUser"},"parentId":{"description":"The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This field is optional, and if not set, a stand-alone script will be created.","type":"string"},"scriptId":{"description":"The script project's Drive ID.","type":"string"},"title":{"description":"The title for the project.","type":"string"},"updateTime":{"description":"When the script was last updated.","format":"google-datetime","type":"string"}}},"script_v1_ScriptStackTraceElement":{"description":"A stack trace through the script that shows where the execution failed.","type":"object","properties":{"function":{"description":"The name of the function that failed.","type":"string"},"lineNumber":{"description":"The line number where the script failed.","format":"int32","type":"integer"}}},"script_v1_Status":{"description":"If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object.","type":"object","properties":{"code":{"description":"The status code. For this API, this value either: - 10, indicating a `SCRIPT_TIMEOUT` error, - 3, indicating an `INVALID_ARGUMENT` error, or - 1, indicating a `CANCELLED` execution. ","format":"int32","type":"integer"},"details":{"description":"An array that contains a single ExecutionError object that provides information about the nature of the error.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the details field, or localized by the client.","type":"string"}}},"script_v1_UpdateDeploymentRequest":{"description":"Request with deployment information to update an existing deployment.","type":"object","properties":{"deploymentConfig":{"$ref":"#/components/schemas/script_v1_DeploymentConfig"}}},"script_v1_Version":{"description":"A resource representing a script project version. A version is a \"snapshot\" of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.","type":"object","properties":{"createTime":{"description":"When the version was created.","format":"google-datetime","type":"string"},"description":{"description":"The description for this version.","type":"string"},"scriptId":{"description":"The script project's Drive ID.","type":"string"},"versionNumber":{"description":"The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.","format":"int32","type":"integer"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/script.projects":"","https://www.googleapis.com/auth/script.deployments":"","https://www.googleapis.com/auth/script.processes":"","https://www.googleapis.com/auth/script.metrics":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/script.projects","https://www.googleapis.com/auth/script.deployments","https://www.googleapis.com/auth/script.processes","https://www.googleapis.com/auth/script.metrics"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/script/v1/rest","service":"script","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Apps Script API","version":"v1","description":"Manages and executes Google Apps Script projects. "},"servers":[{"url":"https://script.googleapis.com/"}],"paths":{"/v1/processes":{"get":{"operationId":"script.processes.list","x-executor-toolPath":"script.processes.list","tags":["Apps Script API"],"description":"List information about processes made by or on behalf of a user, such as process type and current status.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of returned processes per page of results. Defaults to 50.","schema":{"description":"The maximum number of returned processes per page of results. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.deploymentId","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.endTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.functionName","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","schema":{"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.projectName","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with project names containing a specific string.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with project names containing a specific string.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.scriptId","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with a specific script ID.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with a specific script ID.","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.startTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"userProcessFilter.statuses","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","enum":["PROCESS_STATUS_UNSPECIFIED","RUNNING","PAUSED","COMPLETED","CANCELED","FAILED","TIMED_OUT","UNKNOWN","DELAYED","EXECUTION_DISABLED"],"type":"string"}},"style":"form","explode":true},{"name":"userProcessFilter.types","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process types.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process types.","enum":["PROCESS_TYPE_UNSPECIFIED","ADD_ON","EXECUTION_API","TIME_DRIVEN","TRIGGER","WEBAPP","EDITOR","SIMPLE_TRIGGER","MENU","BATCH_TASK"],"type":"string"}},"style":"form","explode":true},{"name":"userProcessFilter.userAccessLevels","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","enum":["USER_ACCESS_LEVEL_UNSPECIFIED","NONE","READ","WRITE","OWNER"],"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListUserProcessesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.processes"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.processes"]}},"/v1/processes:listScriptProcesses":{"get":{"operationId":"script.processes.listScriptProcesses","x-executor-toolPath":"script.processes.listScriptProcesses","tags":["Apps Script API"],"description":"List information about a script's executed processes, such as process type and current status.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of returned processes per page of results. Defaults to 50.","schema":{"description":"The maximum number of returned processes per page of results. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"scriptId","in":"query","required":false,"description":"The script ID of the project whose processes are listed.","schema":{"description":"The script ID of the project whose processes are listed.","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.deploymentId","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","schema":{"description":"Optional field used to limit returned processes to those originating from projects with a specific deployment ID.","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.endTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that completed on or before the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.functionName","in":"query","required":false,"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","schema":{"description":"Optional field used to limit returned processes to those originating from a script function with the given function name.","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.startTime","in":"query","required":false,"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","schema":{"description":"Optional field used to limit returned processes to those that were started on or after the given timestamp.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"scriptProcessFilter.statuses","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process statuses.","enum":["PROCESS_STATUS_UNSPECIFIED","RUNNING","PAUSED","COMPLETED","CANCELED","FAILED","TIMED_OUT","UNKNOWN","DELAYED","EXECUTION_DISABLED"],"type":"string"}},"style":"form","explode":true},{"name":"scriptProcessFilter.types","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified process types.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified process types.","enum":["PROCESS_TYPE_UNSPECIFIED","ADD_ON","EXECUTION_API","TIME_DRIVEN","TRIGGER","WEBAPP","EDITOR","SIMPLE_TRIGGER","MENU","BATCH_TASK"],"type":"string"}},"style":"form","explode":true},{"name":"scriptProcessFilter.userAccessLevels","in":"query","required":false,"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","schema":{"type":"array","items":{"description":"Optional field used to limit returned processes to those having one of the specified user access levels.","enum":["USER_ACCESS_LEVEL_UNSPECIFIED","NONE","READ","WRITE","OWNER"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListScriptProcessesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.processes"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.processes"]}},"/v1/projects":{"post":{"operationId":"script.projects.create","x-executor-toolPath":"script.projects.create","tags":["Apps Script API"],"description":"Creates a new, empty script project with no script files and a base manifest file.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_CreateProjectRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Project"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}":{"get":{"operationId":"script.projects.get","x-executor-toolPath":"script.projects.get","tags":["Apps Script API"],"description":"Gets a script project's metadata.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Project"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects.readonly","https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}/content":{"get":{"operationId":"script.projects.getContent","x-executor-toolPath":"script.projects.getContent","tags":["Apps Script API"],"description":"Gets the content of the script project, including the code source and metadata for each script file.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"versionNumber","in":"query","required":false,"description":"The version number of the project to retrieve. If not provided, the project's HEAD version is returned.","schema":{"description":"The version number of the project to retrieve. If not provided, the project's HEAD version is returned.","format":"int32","type":"integer"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Content"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects.readonly","https://www.googleapis.com/auth/script.projects"]},"put":{"operationId":"script.projects.updateContent","x-executor-toolPath":"script.projects.updateContent","tags":["Apps Script API"],"description":"Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Content"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Content"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}/deployments":{"get":{"operationId":"script.projects.deployments.list","x-executor-toolPath":"script.projects.deployments.list","tags":["Apps Script API"],"description":"Lists the deployments of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of deployments on each returned page. Defaults to 50.","schema":{"description":"The maximum number of deployments on each returned page. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListDeploymentsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments.readonly","https://www.googleapis.com/auth/script.deployments"]},"post":{"operationId":"script.projects.deployments.create","x-executor-toolPath":"script.projects.deployments.create","tags":["Apps Script API"],"description":"Creates a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_DeploymentConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Deployment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]}},"/v1/projects/{scriptId}/deployments/{deploymentId}":{"get":{"operationId":"script.projects.deployments.get","x-executor-toolPath":"script.projects.deployments.get","tags":["Apps Script API"],"description":"Gets a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID.","schema":{"description":"The deployment ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Deployment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments.readonly","https://www.googleapis.com/auth/script.deployments"]},"put":{"operationId":"script.projects.deployments.update","x-executor-toolPath":"script.projects.deployments.update","tags":["Apps Script API"],"description":"Updates a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID for this deployment.","schema":{"description":"The deployment ID for this deployment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_UpdateDeploymentRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Deployment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]},"delete":{"operationId":"script.projects.deployments.delete","x-executor-toolPath":"script.projects.deployments.delete","tags":["Apps Script API"],"description":"Deletes a deployment of an Apps Script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"deploymentId","in":"path","required":true,"description":"The deployment ID to be undeployed.","schema":{"description":"The deployment ID to be undeployed.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.deployments"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.deployments"]}},"/v1/projects/{scriptId}/metrics":{"get":{"operationId":"script.projects.getMetrics","x-executor-toolPath":"script.projects.getMetrics","tags":["Apps Script API"],"description":"Get metrics data for scripts, such as number of executions and active users.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"Required field indicating the script to get metrics for.","schema":{"description":"Required field indicating the script to get metrics for.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"metricsFilter.deploymentId","in":"query","required":false,"description":"Optional field indicating a specific deployment to retrieve metrics from.","schema":{"description":"Optional field indicating a specific deployment to retrieve metrics from.","type":"string"},"style":"form","explode":false},{"name":"metricsGranularity","in":"query","required":false,"description":"Required field indicating what granularity of metrics are returned.","schema":{"description":"Required field indicating what granularity of metrics are returned.","enum":["UNSPECIFIED_GRANULARITY","WEEKLY","DAILY"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Metrics"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.metrics"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.metrics"]}},"/v1/projects/{scriptId}/versions":{"get":{"operationId":"script.projects.versions.list","x-executor-toolPath":"script.projects.versions.list","tags":["Apps Script API"],"description":"List the versions of a script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of versions on each returned page. Defaults to 50.","schema":{"description":"The maximum number of versions on each returned page. Defaults to 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_ListVersionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects.readonly","https://www.googleapis.com/auth/script.projects"]},"post":{"operationId":"script.projects.versions.create","x-executor-toolPath":"script.projects.versions.create","tags":["Apps Script API"],"description":"Creates a new immutable version using the current code, with a unique version number.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Version"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Version"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects"]}},"/v1/projects/{scriptId}/versions/{versionNumber}":{"get":{"operationId":"script.projects.versions.get","x-executor-toolPath":"script.projects.versions.get","tags":["Apps Script API"],"description":"Gets a version of a script project.","parameters":[{"name":"scriptId","in":"path","required":true,"description":"The script project's Drive ID.","schema":{"description":"The script project's Drive ID.","type":"string"}},{"name":"versionNumber","in":"path","required":true,"description":"The version number.","schema":{"description":"The version number.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/script_v1_Version"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/script.projects.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/script.projects"]}],"x-google-scopes":["https://www.googleapis.com/auth/script.projects.readonly","https://www.googleapis.com/auth/script.projects"]}}},"components":{"schemas":{"script_v1_Content":{"description":"The Content resource.","type":"object","properties":{"files":{"description":"The list of script project files. One of the files is a script manifest; it must be named \"appsscript\", must have type of JSON, and include the manifest configurations for the project.","type":"array","items":{"$ref":"#/components/schemas/script_v1_File"}},"scriptId":{"description":"The script project's Drive ID.","type":"string"}}},"script_v1_CreateProjectRequest":{"description":"Request to create a script project.","type":"object","properties":{"parentId":{"description":"The Drive ID of a parent file that the created script project is bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google Slides file. If not set, a standalone script project is created.","type":"string"},"title":{"description":"The title for the project.","type":"string"}}},"script_v1_Deployment":{"description":"Representation of a single script deployment.","type":"object","properties":{"deploymentConfig":{"$ref":"#/components/schemas/script_v1_DeploymentConfig"},"deploymentId":{"description":"The deployment ID for this deployment.","type":"string"},"entryPoints":{"description":"The deployment's entry points.","type":"array","items":{"$ref":"#/components/schemas/script_v1_EntryPoint"}},"updateTime":{"description":"Last modified date time stamp.","format":"google-datetime","type":"string"}}},"script_v1_DeploymentConfig":{"description":"Metadata the defines how a deployment is configured.","type":"object","properties":{"description":{"description":"The description for this deployment.","type":"string"},"manifestFileName":{"description":"The manifest file name for this deployment.","type":"string"},"scriptId":{"description":"The script project's Drive ID.","type":"string"},"versionNumber":{"description":"The version number on which this deployment is based.","format":"int32","type":"integer"}}},"script_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"script_v1_EntryPoint":{"description":"A configuration that defines how a deployment is accessed externally.","type":"object","properties":{"addOn":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeAddOnEntryPoint"},"entryPointType":{"description":"The type of the entry point.","enum":["ENTRY_POINT_TYPE_UNSPECIFIED","WEB_APP","EXECUTION_API","ADD_ON"],"type":"string"},"executionApi":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeExecutionApiEntryPoint"},"webApp":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeWebAppEntryPoint"}}},"script_v1_ExecutionError":{"description":"An object that provides information about the nature of an error resulting from an attempted execution of a script function using the Apps Script API. If a run call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains a Status object. The `Status` object's `details` field contains an array with a single one of these `ExecutionError` objects.","type":"object","properties":{"errorMessage":{"description":"The error message thrown by Apps Script, usually localized into the user's language.","type":"string"},"errorType":{"description":"The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included.","type":"string"},"scriptStackTraceElements":{"description":"An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.","type":"array","items":{"$ref":"#/components/schemas/script_v1_ScriptStackTraceElement"}}}},"script_v1_ExecutionRequest":{"description":"A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script returns results based on the implementation of the script.","type":"object","properties":{"devMode":{"description":"If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Apps Script API. Optional; default is `false`.","type":"boolean"},"function":{"description":"The name of the function to execute in the given script. The name does not include parentheses or parameters. It can reference a function in an included library such as `Library.libFunction1`.","type":"string"},"parameters":{"description":"The parameters to be passed to the function being executed. The object type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific object types (such as a `Document` or a `Calendar`); they can only be primitive types such as `string`, `number`, `array`, `object`, or `boolean`. Optional.","type":"array","items":{}},"sessionState":{"description":"*Deprecated*. For use with Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the [Intent](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/bound) script—that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`. Optional.","type":"string"}}},"script_v1_ExecutionResponse":{"description":"An object that provides the return value of a function executed using the Apps Script API. If the script function returns successfully, the response body's response field contains this `ExecutionResponse` object.","type":"object","properties":{"result":{"description":"The return value of the script function. The type matches the object type returned in Apps Script. Functions called using the Apps Script API cannot return Apps Script-specific objects (such as a `Document` or a `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`."}}},"script_v1_File":{"description":"An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.","type":"object","properties":{"createTime":{"description":"Creation date timestamp.","format":"google-datetime","type":"string"},"functionSet":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeFunctionSet"},"lastModifyUser":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeUser"},"name":{"description":"The name of the file. The file extension is not part of the file name, which can be identified from the type field.","type":"string"},"source":{"description":"The file content.","type":"string"},"type":{"description":"The type of the file.","enum":["ENUM_TYPE_UNSPECIFIED","SERVER_JS","HTML","JSON"],"type":"string"},"updateTime":{"description":"Last modified date timestamp.","format":"google-datetime","type":"string"}}},"script_v1_GoogleAppsScriptTypeAddOnEntryPoint":{"description":"An add-on entry point.","type":"object","properties":{"addOnType":{"description":"The add-on's required list of supported container types.","enum":["UNKNOWN_ADDON_TYPE","GMAIL","DATA_STUDIO"],"type":"string"},"description":{"description":"The add-on's optional description.","type":"string"},"helpUrl":{"description":"The add-on's optional help URL.","type":"string"},"postInstallTipUrl":{"description":"The add-on's required post install tip URL.","type":"string"},"reportIssueUrl":{"description":"The add-on's optional report issue URL.","type":"string"},"title":{"description":"The add-on's required title.","type":"string"}}},"script_v1_GoogleAppsScriptTypeExecutionApiConfig":{"description":"API executable entry point configuration.","type":"object","properties":{"access":{"description":"Who has permission to run the API executable.","enum":["UNKNOWN_ACCESS","MYSELF","DOMAIN","ANYONE","ANYONE_ANONYMOUS"],"type":"string"}}},"script_v1_GoogleAppsScriptTypeExecutionApiEntryPoint":{"description":"An API executable entry point.","type":"object","properties":{"entryPointConfig":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeExecutionApiConfig"}}},"script_v1_GoogleAppsScriptTypeFunction":{"description":"Represents a function in a script project.","type":"object","properties":{"name":{"description":"The function name in the script project.","type":"string"},"parameters":{"description":"The ordered list of parameter names of the function in the script project.","type":"array","items":{"type":"string"}}}},"script_v1_GoogleAppsScriptTypeFunctionSet":{"description":"A set of functions. No duplicates are permitted.","type":"object","properties":{"values":{"description":"A list of functions composing the set.","type":"array","items":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeFunction"}}}},"script_v1_GoogleAppsScriptTypeProcess":{"description":"Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API.","type":"object","properties":{"duration":{"description":"Duration the execution spent executing.","format":"google-duration","type":"string"},"functionName":{"description":"Name of the function the started the execution.","type":"string"},"processStatus":{"description":"The executions status.","enum":["PROCESS_STATUS_UNSPECIFIED","RUNNING","PAUSED","COMPLETED","CANCELED","FAILED","TIMED_OUT","UNKNOWN","DELAYED","EXECUTION_DISABLED"],"type":"string"},"processType":{"description":"The executions type.","enum":["PROCESS_TYPE_UNSPECIFIED","ADD_ON","EXECUTION_API","TIME_DRIVEN","TRIGGER","WEBAPP","EDITOR","SIMPLE_TRIGGER","MENU","BATCH_TASK"],"type":"string"},"projectName":{"description":"Name of the script being executed.","type":"string"},"runtimeVersion":{"description":"Which version of maestro to use to execute the script.","enum":["RUNTIME_VERSION_UNSPECIFIED","DEPRECATED_ES5","V8"],"type":"string"},"startTime":{"description":"Time the execution started.","format":"google-datetime","type":"string"},"userAccessLevel":{"description":"The executing users access level to the script.","enum":["USER_ACCESS_LEVEL_UNSPECIFIED","NONE","READ","WRITE","OWNER"],"type":"string"}}},"script_v1_GoogleAppsScriptTypeUser":{"description":"A simple user profile resource.","type":"object","properties":{"domain":{"description":"The user's domain.","type":"string"},"email":{"description":"The user's identifying email address.","type":"string"},"name":{"description":"The user's display name.","type":"string"},"photoUrl":{"description":"The user's photo.","type":"string"}}},"script_v1_GoogleAppsScriptTypeWebAppConfig":{"description":"Web app entry point configuration.","type":"object","properties":{"access":{"description":"Who has permission to run the web app.","enum":["UNKNOWN_ACCESS","MYSELF","DOMAIN","ANYONE","ANYONE_ANONYMOUS"],"type":"string"},"executeAs":{"description":"Who to execute the web app as.","enum":["UNKNOWN_EXECUTE_AS","USER_ACCESSING","USER_DEPLOYING"],"type":"string"}}},"script_v1_GoogleAppsScriptTypeWebAppEntryPoint":{"description":"A web application entry point.","type":"object","properties":{"entryPointConfig":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeWebAppConfig"},"url":{"description":"The URL for the web application.","type":"string"}}},"script_v1_ListDeploymentsResponse":{"description":"Response with the list of deployments for the specified Apps Script project.","type":"object","properties":{"deployments":{"description":"The list of deployments.","type":"array","items":{"$ref":"#/components/schemas/script_v1_Deployment"}},"nextPageToken":{"description":"The token that can be used in the next call to get the next page of results.","type":"string"}}},"script_v1_ListScriptProcessesResponse":{"description":"Response with the list of Process resources.","type":"object","properties":{"nextPageToken":{"description":"Token for the next page of results. If empty, there are no more pages remaining.","type":"string"},"processes":{"description":"List of processes matching request parameters.","type":"array","items":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeProcess"}}}},"script_v1_ListUserProcessesResponse":{"description":"Response with the list of Process resources.","type":"object","properties":{"nextPageToken":{"description":"Token for the next page of results. If empty, there are no more pages remaining.","type":"string"},"processes":{"description":"List of processes matching request parameters.","type":"array","items":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeProcess"}}}},"script_v1_ListVersionsResponse":{"description":"Response with the list of the versions for the specified script project.","type":"object","properties":{"nextPageToken":{"description":"The token use to fetch the next page of records. if not exist in the response, that means no more versions to list.","type":"string"},"versions":{"description":"The list of versions.","type":"array","items":{"$ref":"#/components/schemas/script_v1_Version"}}}},"script_v1_Metrics":{"description":"Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.","type":"object","properties":{"activeUsers":{"description":"Number of active users.","type":"array","items":{"$ref":"#/components/schemas/script_v1_MetricsValue"}},"failedExecutions":{"description":"Number of failed executions.","type":"array","items":{"$ref":"#/components/schemas/script_v1_MetricsValue"}},"totalExecutions":{"description":"Number of total executions.","type":"array","items":{"$ref":"#/components/schemas/script_v1_MetricsValue"}}}},"script_v1_MetricsValue":{"description":"Metrics value that holds number of executions counted.","type":"object","properties":{"endTime":{"description":"Required field indicating the end time of the interval.","format":"google-datetime","type":"string"},"startTime":{"description":"Required field indicating the start time of the interval.","format":"google-datetime","type":"string"},"value":{"description":"Indicates the number of executions counted.","format":"uint64","type":"string"}}},"script_v1_Operation":{"description":"A representation of an execution of an Apps Script function started with run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). After execution has started, it can have one of four outcomes: - If the script function returns successfully, the response field contains an ExecutionResponse object with the function's return value in the object's `result` field. - If the script function (or Apps Script itself) throws an exception, the error field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error. - If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present. - If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries automatically convert a 4XX response into an exception class. ","type":"object","properties":{"done":{"description":"This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed.","type":"boolean"},"error":{"$ref":"#/components/schemas/script_v1_Status"},"response":{"description":"If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}}},"script_v1_Project":{"description":"The script project resource.","type":"object","properties":{"createTime":{"description":"When the script was created.","format":"google-datetime","type":"string"},"creator":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeUser"},"lastModifyUser":{"$ref":"#/components/schemas/script_v1_GoogleAppsScriptTypeUser"},"parentId":{"description":"The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This field is optional, and if not set, a stand-alone script will be created.","type":"string"},"scriptId":{"description":"The script project's Drive ID.","type":"string"},"title":{"description":"The title for the project.","type":"string"},"updateTime":{"description":"When the script was last updated.","format":"google-datetime","type":"string"}}},"script_v1_ScriptStackTraceElement":{"description":"A stack trace through the script that shows where the execution failed.","type":"object","properties":{"function":{"description":"The name of the function that failed.","type":"string"},"lineNumber":{"description":"The line number where the script failed.","format":"int32","type":"integer"}}},"script_v1_Status":{"description":"If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object.","type":"object","properties":{"code":{"description":"The status code. For this API, this value either: - 10, indicating a `SCRIPT_TIMEOUT` error, - 3, indicating an `INVALID_ARGUMENT` error, or - 1, indicating a `CANCELLED` execution. ","format":"int32","type":"integer"},"details":{"description":"An array that contains a single ExecutionError object that provides information about the nature of the error.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the details field, or localized by the client.","type":"string"}}},"script_v1_UpdateDeploymentRequest":{"description":"Request with deployment information to update an existing deployment.","type":"object","properties":{"deploymentConfig":{"$ref":"#/components/schemas/script_v1_DeploymentConfig"}}},"script_v1_Version":{"description":"A resource representing a script project version. A version is a \"snapshot\" of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.","type":"object","properties":{"createTime":{"description":"When the version was created.","format":"google-datetime","type":"string"},"description":{"description":"The description for this version.","type":"string"},"scriptId":{"description":"The script project's Drive ID.","type":"string"},"versionNumber":{"description":"The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.","format":"int32","type":"integer"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/script.projects":"Create and update Google Apps Script projects","https://www.googleapis.com/auth/script.deployments":"Create and update Google Apps Script deployments","https://www.googleapis.com/auth/script.processes":"View Google Apps Script processes","https://www.googleapis.com/auth/script.metrics":"View Google Apps Script project's metrics","https://www.googleapis.com/auth/script.projects.readonly":"View Google Apps Script projects","https://www.googleapis.com/auth/script.deployments.readonly":"View Google Apps Script deployments"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/script.projects","https://www.googleapis.com/auth/script.deployments","https://www.googleapis.com/auth/script.processes","https://www.googleapis.com/auth/script.metrics"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/script/v1/rest","service":"script","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-bigquery.json b/public/specs/google/google-bigquery.json index bf00f616..861f75c4 100644 --- a/public/specs/google/google-bigquery.json +++ b/public/specs/google/google-bigquery.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"BigQuery API","version":"v2","description":"A data platform for customers to create, manage, share and query data."},"servers":[{"url":"https://bigquery.googleapis.com/bigquery/v2/"}],"paths":{"/projects":{"get":{"operationId":"bigquery.projects.list","x-executor-toolPath":"bigquery.projects.list","tags":["BigQuery API"],"description":"RPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the [Resource Manager](https://cloud.google.com/resource-manager/docs/) API, which provides the underlying data for this method and has more capabilities. # IAM Permissions Requires no specific IAM permission(s) to use this method. The results are filtered to only include projects on which the caller has been granted a project-level role such as a BigQuery predefined IAM role or a basic role such as Viewer or Owner.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"`maxResults` unset returns all results, up to 50 per page. Additionally, the number of projects in a page may be fewer than `maxResults` because projects are retrieved and then filtered to only projects with the BigQuery API enabled.","schema":{"description":"`maxResults` unset returns all results, up to 50 per page. Additionally, the number of projects in a page may be fewer than `maxResults` because projects are retrieved and then filtered to only projects with the BigQuery API enabled.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results. If not present, no further pages are present.","schema":{"description":"Page token, returned by a previous call, to request the next page of results. If not present, no further pages are present.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ProjectList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets":{"get":{"operationId":"bigquery.datasets.list","x-executor-toolPath":"bigquery.datasets.list","tags":["BigQuery API"],"description":"Lists all datasets in the specified project to which the user has been granted the READER dataset role. # IAM Permissions Requires no specific IAM permission(s) to use this method. Results are filtered to only include datasets on which the caller has the `bigquery.datasets.get` permission.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the datasets to be listed","schema":{"description":"Required. Project ID of the datasets to be listed","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"all","in":"query","required":false,"description":"Whether to list all datasets, including hidden ones","schema":{"description":"Whether to list all datasets, including hidden ones","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.","schema":{"description":"An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results","schema":{"description":"Page token, returned by a previous call, to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_DatasetList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.datasets.insert","x-executor-toolPath":"bigquery.datasets.insert","tags":["BigQuery API"],"description":"Creates a new empty dataset. # IAM Permissions Requires the `bigquery.datasets.create` permission on the project.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the new dataset","schema":{"description":"Required. Project ID of the new dataset","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","schema":{"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}":{"get":{"operationId":"bigquery.datasets.get","x-executor-toolPath":"bigquery.datasets.get","tags":["BigQuery API"],"description":"Returns the dataset specified by datasetID. # IAM Permissions Requires the `bigquery.datasets.get` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested dataset","schema":{"description":"Required. Project ID of the requested dataset","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested dataset","schema":{"description":"Required. Dataset ID of the requested dataset","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to [IAM Policy version] (https://cloud.google.com/iam/docs/policies#versions) and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { \"access\": [ { \"role\": \"roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda\", \"userByEmail\": \"user@example.com\", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.","schema":{"description":"Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to [IAM Policy version] (https://cloud.google.com/iam/docs/policies#versions) and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { \"access\": [ { \"role\": \"roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda\", \"userByEmail\": \"user@example.com\", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"datasetView","in":"query","required":false,"description":"Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.","schema":{"description":"Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.","enum":["DATASET_VIEW_UNSPECIFIED","METADATA","ACL","FULL"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.datasets.update","x-executor-toolPath":"bigquery.datasets.update","tags":["BigQuery API"],"description":"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. # IAM Permissions Requires the `bigquery.datasets.update` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset being updated","schema":{"description":"Required. Project ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the dataset being updated","schema":{"description":"Required. Dataset ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","schema":{"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMode","in":"query","required":false,"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","schema":{"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","enum":["UPDATE_MODE_UNSPECIFIED","UPDATE_METADATA","UPDATE_ACL","UPDATE_FULL"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.datasets.delete","x-executor-toolPath":"bigquery.datasets.delete","tags":["BigQuery API"],"description":"Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. # IAM Permissions Requires the `bigquery.datasets.delete` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset being deleted","schema":{"description":"Required. Project ID of the dataset being deleted","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of dataset being deleted","schema":{"description":"Required. Dataset ID of dataset being deleted","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleteContents","in":"query","required":false,"description":"If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False","schema":{"description":"If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"patch":{"operationId":"bigquery.datasets.patch","x-executor-toolPath":"bigquery.datasets.patch","tags":["BigQuery API"],"description":"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.datasets.update` on the dataset. - `bigquery.datasets.get` on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset being updated","schema":{"description":"Required. Project ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the dataset being updated","schema":{"description":"Required. Dataset ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","schema":{"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMode","in":"query","required":false,"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","schema":{"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","enum":["UPDATE_MODE_UNSPECIFIED","UPDATE_METADATA","UPDATE_ACL","UPDATE_FULL"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/models":{"get":{"operationId":"bigquery.models.list","x-executor-toolPath":"bigquery.models.list","tags":["BigQuery API"],"description":"Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method. # IAM Permissions Requires the `bigquery.models.list` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the models to list.","schema":{"description":"Required. Project ID of the models to list.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the models to list.","schema":{"description":"Required. Dataset ID of the models to list.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call to request the next page of results","schema":{"description":"Page token, returned by a previous call to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ListModelsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/models/{modelId}":{"get":{"operationId":"bigquery.models.get","x-executor-toolPath":"bigquery.models.get","tags":["BigQuery API"],"description":"Gets the specified model resource by model ID. # IAM Permissions Requires the `bigquery.models.getMetadata` permission on the model.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested model.","schema":{"description":"Required. Project ID of the requested model.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested model.","schema":{"description":"Required. Dataset ID of the requested model.","type":"string"},"allowReserved":true},{"name":"modelId","in":"path","required":true,"description":"Required. Model ID of the requested model.","schema":{"description":"Required. Model ID of the requested model.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Model"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.models.delete","x-executor-toolPath":"bigquery.models.delete","tags":["BigQuery API"],"description":"Deletes the model specified by modelId from the dataset. # IAM Permissions Requires the `bigquery.models.delete` permission on the model.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the model to delete.","schema":{"description":"Required. Project ID of the model to delete.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the model to delete.","schema":{"description":"Required. Dataset ID of the model to delete.","type":"string"},"allowReserved":true},{"name":"modelId","in":"path","required":true,"description":"Required. Model ID of the model to delete.","schema":{"description":"Required. Model ID of the model to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"patch":{"operationId":"bigquery.models.patch","x-executor-toolPath":"bigquery.models.patch","tags":["BigQuery API"],"description":"Patch specific fields in the specified model. # IAM Permissions Requires the `bigquery.models.updateMetadata` permission on the model.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the model to patch.","schema":{"description":"Required. Project ID of the model to patch.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the model to patch.","schema":{"description":"Required. Dataset ID of the model to patch.","type":"string"},"allowReserved":true},{"name":"modelId","in":"path","required":true,"description":"Required. Model ID of the model to patch.","schema":{"description":"Required. Model ID of the model to patch.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Model"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Model"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/routines":{"get":{"operationId":"bigquery.routines.list","x-executor-toolPath":"bigquery.routines.list","tags":["BigQuery API"],"description":"Lists all routines in the specified dataset. Requires the READER dataset role. # IAM Permissions Requires the `bigquery.routines.list` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the routines to list","schema":{"description":"Required. Project ID of the routines to list","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the routines to list","schema":{"description":"Required. Dataset ID of the routines to list","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"If set, then only the Routines matching this filter are returned. The supported format is `routineType:{RoutineType}`, where `{RoutineType}` is a RoutineType enum. For example: `routineType:SCALAR_FUNCTION`.","schema":{"description":"If set, then only the Routines matching this filter are returned. The supported format is `routineType:{RoutineType}`, where `{RoutineType}` is a RoutineType enum. For example: `routineType:SCALAR_FUNCTION`.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results","schema":{"description":"Page token, returned by a previous call, to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":false,"description":"If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.","schema":{"description":"If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ListRoutinesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.routines.insert","x-executor-toolPath":"bigquery.routines.insert","tags":["BigQuery API"],"description":"Creates a new routine in the dataset. # IAM Permissions Requires the `bigquery.routines.create` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the new routine","schema":{"description":"Required. Project ID of the new routine","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the new routine","schema":{"description":"Required. Dataset ID of the new routine","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/routines/{routineId}":{"get":{"operationId":"bigquery.routines.get","x-executor-toolPath":"bigquery.routines.get","tags":["BigQuery API"],"description":"Gets the specified routine resource by routine ID. # IAM Permissions Requires the `bigquery.routines.get` permission on the routine.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested routine","schema":{"description":"Required. Project ID of the requested routine","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested routine","schema":{"description":"Required. Dataset ID of the requested routine","type":"string"},"allowReserved":true},{"name":"routineId","in":"path","required":true,"description":"Required. Routine ID of the requested routine","schema":{"description":"Required. Routine ID of the requested routine","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":false,"description":"If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.","schema":{"description":"If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.routines.update","x-executor-toolPath":"bigquery.routines.update","tags":["BigQuery API"],"description":"Updates information in an existing routine. The update method replaces the entire Routine resource. # IAM Permissions Requires the `bigquery.routines.update` permission on the routine.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the routine to update","schema":{"description":"Required. Project ID of the routine to update","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the routine to update","schema":{"description":"Required. Dataset ID of the routine to update","type":"string"},"allowReserved":true},{"name":"routineId","in":"path","required":true,"description":"Required. Routine ID of the routine to update","schema":{"description":"Required. Routine ID of the routine to update","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.routines.delete","x-executor-toolPath":"bigquery.routines.delete","tags":["BigQuery API"],"description":"Deletes the routine specified by routineId from the dataset. # IAM Permissions Requires the `bigquery.routines.delete` permission on the routine.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the routine to delete","schema":{"description":"Required. Project ID of the routine to delete","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the routine to delete","schema":{"description":"Required. Dataset ID of the routine to delete","type":"string"},"allowReserved":true},{"name":"routineId","in":"path","required":true,"description":"Required. Routine ID of the routine to delete","schema":{"description":"Required. Routine ID of the routine to delete","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables":{"get":{"operationId":"bigquery.tables.list","x-executor-toolPath":"bigquery.tables.list","tags":["BigQuery API"],"description":"Lists all tables in the specified dataset. Requires the READER dataset role. # IAM Permissions Requires the `bigquery.tables.list` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the tables to list","schema":{"description":"Required. Project ID of the tables to list","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the tables to list","schema":{"description":"Required. Dataset ID of the tables to list","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results","schema":{"description":"Page token, returned by a previous call, to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.tables.insert","x-executor-toolPath":"bigquery.tables.insert","tags":["BigQuery API"],"description":"Creates a new, empty table in the dataset. # IAM Permissions Requires the `bigquery.tables.create` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the new table","schema":{"description":"Required. Project ID of the new table","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the new table","schema":{"description":"Required. Dataset ID of the new table","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}":{"get":{"operationId":"bigquery.tables.get","x-executor-toolPath":"bigquery.tables.get","tags":["BigQuery API"],"description":"Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. # IAM Permissions Requires the `bigquery.tables.get` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested table","schema":{"description":"Required. Project ID of the requested table","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested table","schema":{"description":"Required. Dataset ID of the requested table","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the requested table","schema":{"description":"Required. Table ID of the requested table","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"selectedFields","in":"query","required":false,"description":"List of table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed.","schema":{"description":"List of table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"view","in":"query","required":false,"description":"Optional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.","schema":{"description":"Optional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.","enum":["TABLE_METADATA_VIEW_UNSPECIFIED","BASIC","STORAGE_STATS","FULL"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.tables.update","x-executor-toolPath":"bigquery.tables.update","tags":["BigQuery API"],"description":"Updates information in an existing table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided in the submitted Table resource. # IAM Permissions Requires the `bigquery.tables.update` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to update","schema":{"description":"Required. Project ID of the table to update","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to update","schema":{"description":"Required. Dataset ID of the table to update","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to update","schema":{"description":"Required. Table ID of the table to update","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"autodetect_schema","in":"query","required":false,"description":"Optional. When true will autodetect schema, else will keep original schema","schema":{"description":"Optional. When true will autodetect schema, else will keep original schema","type":"boolean"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.tables.delete","x-executor-toolPath":"bigquery.tables.delete","tags":["BigQuery API"],"description":"Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. # IAM Permissions Requires the `bigquery.tables.delete` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to delete","schema":{"description":"Required. Project ID of the table to delete","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to delete","schema":{"description":"Required. Dataset ID of the table to delete","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to delete","schema":{"description":"Required. Table ID of the table to delete","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"patch":{"operationId":"bigquery.tables.patch","x-executor-toolPath":"bigquery.tables.patch","tags":["BigQuery API"],"description":"Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.tables.update` - `bigquery.tables.get`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to update","schema":{"description":"Required. Project ID of the table to update","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to update","schema":{"description":"Required. Dataset ID of the table to update","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to update","schema":{"description":"Required. Table ID of the table to update","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"autodetect_schema","in":"query","required":false,"description":"Optional. When true will autodetect schema, else will keep original schema","schema":{"description":"Optional. When true will autodetect schema, else will keep original schema","type":"boolean"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data":{"get":{"operationId":"bigquery.tabledata.list","x-executor-toolPath":"bigquery.tabledata.list","tags":["BigQuery API"],"description":"List the content of a table in rows. # IAM Permissions Requires the `bigquery.tables.getData` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project id of the table to list.","schema":{"description":"Required. Project id of the table to list.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset id of the table to list.","schema":{"description":"Required. Dataset id of the table to list.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table id of the table to list.","schema":{"description":"Required. Table id of the table to list.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"formatOptions.timestampOutputFormat","in":"query","required":false,"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","schema":{"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","enum":["TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED","FLOAT64","INT64","ISO8601_STRING"],"type":"string"},"style":"form","explode":false},{"name":"formatOptions.useInt64Timestamp","in":"query","required":false,"description":"Optional. Output timestamp as usec int64. Default is false.","schema":{"description":"Optional. Output timestamp as usec int64. Default is false.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Row limit of the table.","schema":{"description":"Row limit of the table.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"To retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list.","schema":{"description":"To retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"selectedFields","in":"query","required":false,"description":"Subset of fields to return, supports select into sub fields. Example: selected_fields = \"a,e.d.f\";","schema":{"description":"Subset of fields to return, supports select into sub fields. Example: selected_fields = \"a,e.d.f\";","type":"string"},"style":"form","explode":false},{"name":"startIndex","in":"query","required":false,"description":"Start row index of the table.","schema":{"description":"Start row index of the table.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableDataList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll":{"post":{"operationId":"bigquery.tabledata.insertAll","x-executor-toolPath":"bigquery.tabledata.insertAll","tags":["BigQuery API"],"description":"Streams data into BigQuery one record at a time without needing to run a load job. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.tables.updateData` on the table. - `bigquery.tables.get` on the table. - `bigquery.datasets.get` on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the destination.","schema":{"description":"Required. Project ID of the destination.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the destination.","schema":{"description":"Required. Dataset ID of the destination.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the destination.","schema":{"description":"Required. Table ID of the destination.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableDataInsertAllRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableDataInsertAllResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/rowAccessPolicies":{"get":{"operationId":"bigquery.rowAccessPolicies.list","x-executor-toolPath":"bigquery.rowAccessPolicies.list","tags":["BigQuery API"],"description":"Lists all row access policies on the specified table. # IAM Permissions Requires the `bigquery.rowAccessPolicies.list` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the row access policies to list.","schema":{"description":"Required. Project ID of the row access policies to list.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of row access policies to list.","schema":{"description":"Required. Dataset ID of row access policies to list.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to list row access policies.","schema":{"description":"Required. Table ID of the table to list row access policies.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results.","schema":{"description":"Page token, returned by a previous call, to request the next page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ListRowAccessPoliciesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.rowAccessPolicies.insert","x-executor-toolPath":"bigquery.rowAccessPolicies.insert","tags":["BigQuery API"],"description":"Creates a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.create` - `bigquery.rowAccessPolicies.setIamPolicy` - `bigquery.tables.getData`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to get the row access policy.","schema":{"description":"Required. Project ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to get the row access policy.","schema":{"description":"Required. Dataset ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to get the row access policy.","schema":{"description":"Required. Table ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/rowAccessPolicies/{policyId}":{"get":{"operationId":"bigquery.rowAccessPolicies.get","x-executor-toolPath":"bigquery.rowAccessPolicies.get","tags":["BigQuery API"],"description":"Gets the specified row access policy by policy ID. # IAM Permissions Requires the `bigquery.rowAccessPolicies.get` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to get the row access policy.","schema":{"description":"Required. Project ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to get the row access policy.","schema":{"description":"Required. Dataset ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to get the row access policy.","schema":{"description":"Required. Table ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"policyId","in":"path","required":true,"description":"Required. Policy ID of the row access policy.","schema":{"description":"Required. Policy ID of the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.rowAccessPolicies.update","x-executor-toolPath":"bigquery.rowAccessPolicies.update","tags":["BigQuery API"],"description":"Updates a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.update` - `bigquery.rowAccessPolicies.setIamPolicy` - `bigquery.tables.getData`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to get the row access policy.","schema":{"description":"Required. Project ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to get the row access policy.","schema":{"description":"Required. Dataset ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to get the row access policy.","schema":{"description":"Required. Table ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"policyId","in":"path","required":true,"description":"Required. Policy ID of the row access policy.","schema":{"description":"Required. Policy ID of the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.rowAccessPolicies.delete","x-executor-toolPath":"bigquery.rowAccessPolicies.delete","tags":["BigQuery API"],"description":"Deletes a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.delete` - `bigquery.rowAccessPolicies.setIamPolicy`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to delete the row access policy.","schema":{"description":"Required. Project ID of the table to delete the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to delete the row access policy.","schema":{"description":"Required. Dataset ID of the table to delete the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to delete the row access policy.","schema":{"description":"Required. Table ID of the table to delete the row access policy.","type":"string"},"allowReserved":true},{"name":"policyId","in":"path","required":true,"description":"Required. Policy ID of the row access policy.","schema":{"description":"Required. Policy ID of the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"force","in":"query","required":false,"description":"If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.","schema":{"description":"If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/rowAccessPolicies:batchDelete":{"post":{"operationId":"bigquery.rowAccessPolicies.batchDelete","x-executor-toolPath":"bigquery.rowAccessPolicies.batchDelete","tags":["BigQuery API"],"description":"Deletes provided row access policies. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.delete` - `bigquery.rowAccessPolicies.setIamPolicy`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to delete the row access policies.","schema":{"description":"Required. Project ID of the table to delete the row access policies.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to delete the row access policies.","schema":{"description":"Required. Dataset ID of the table to delete the row access policies.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to delete the row access policies.","schema":{"description":"Required. Table ID of the table to delete the row access policies.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_BatchDeleteRowAccessPoliciesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}:undelete":{"post":{"operationId":"bigquery.datasets.undelete","x-executor-toolPath":"bigquery.datasets.undelete","tags":["BigQuery API"],"description":"Undeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.datasets.create` on the project. - `bigquery.datasets.get` on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset to be undeleted","schema":{"description":"Required. Project ID of the dataset to be undeleted","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of dataset being deleted","schema":{"description":"Required. Dataset ID of dataset being deleted","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_UndeleteDatasetRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs":{"get":{"operationId":"bigquery.jobs.list","x-executor-toolPath":"bigquery.jobs.list","tags":["BigQuery API"],"description":"Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. # IAM Permissions Requires no specific IAM permission(s) to use this method. Users are able to list the jobs they created. Additional access is granted based on the following permissions: - Users with the `bigquery.jobs.listAll` permission can list all jobs with all metadata. - Users with the `bigquery.jobs.list` permission can list all jobs, but with redacted information for jobs they did not create.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Project ID of the jobs to list.","schema":{"description":"Project ID of the jobs to list.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allUsers","in":"query","required":false,"description":"Whether to display jobs owned by all users in the project. Default False.","schema":{"description":"Whether to display jobs owned by all users in the project. Default False.","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxCreationTime","in":"query","required":false,"description":"Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.","schema":{"description":"Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"minCreationTime","in":"query","required":false,"description":"Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.","schema":{"description":"Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results.","schema":{"description":"Page token, returned by a previous call, to request the next page of results.","type":"string"},"style":"form","explode":false},{"name":"parentJobId","in":"query","required":false,"description":"If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.","schema":{"description":"If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Restrict information returned to a set of selected fields","schema":{"description":"Restrict information returned to a set of selected fields","enum":["full","minimal"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"stateFilter","in":"query","required":false,"description":"Filter for job state","schema":{"type":"array","items":{"description":"Filter for job state","enum":["done","pending","running"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_JobList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.jobs.insert","x-executor-toolPath":"bigquery.jobs.insert","tags":["BigQuery API"],"description":"Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts. # IAM Permissions Requires the `bigquery.jobs.create` permission on the project resource. Additional permissions are required depending on the job type: - **Load, Export, and Copy jobs**: Generally require data-level permissions such as `bigquery.tables.export` or access to external storage. - **Query jobs**: Permissions are dependent on the SQL statement. Complex queries (DDL, DCL) may require additional permissions to create reservations, modify IAM policies, or update project settings.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Project ID of project that will be billed for the job.","schema":{"description":"Project ID of project that will be billed for the job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs/{jobId}":{"get":{"operationId":"bigquery.jobs.get","x-executor-toolPath":"bigquery.jobs.get","tags":["BigQuery API"],"description":"Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. # IAM Permissions Requires the `bigquery.jobs.get` permission on the job resource. If the user matches the creator of the job, the `bigquery.jobs.create` permission on the project is required instead.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested job.","schema":{"description":"Required. Project ID of the requested job.","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the requested job.","schema":{"description":"Required. Job ID of the requested job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","schema":{"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs/{jobId}/cancel":{"post":{"operationId":"bigquery.jobs.cancel","x-executor-toolPath":"bigquery.jobs.cancel","tags":["BigQuery API"],"description":"Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. # IAM Permissions Requires the `bigquery.jobs.update` permission on the job resource. If the user matches the creator of the job, the `bigquery.jobs.create` permission on the project is required instead.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the job to cancel","schema":{"description":"Required. Project ID of the job to cancel","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the job to cancel","schema":{"description":"Required. Job ID of the job to cancel","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. You must [specify the location](https://cloud.google.com/bigquery/docs/locations#specify_locations) to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`)","schema":{"description":"The geographic location of the job. You must [specify the location](https://cloud.google.com/bigquery/docs/locations#specify_locations) to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`)","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_JobCancelResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs/{jobId}/delete":{"delete":{"operationId":"bigquery.jobs.delete","x-executor-toolPath":"bigquery.jobs.delete","tags":["BigQuery API"],"description":"Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted. # IAM Permissions Requires the `bigquery.jobs.delete` permission on the job resource.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the job for which metadata is to be deleted.","schema":{"description":"Required. Project ID of the job for which metadata is to be deleted.","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed.","schema":{"description":"Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. Required. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","schema":{"description":"The geographic location of the job. Required. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/queries":{"post":{"operationId":"bigquery.jobs.query","x-executor-toolPath":"bigquery.jobs.query","tags":["BigQuery API"],"description":"Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. # IAM Permissions Requires the `bigquery.jobs.create` permission on the project resource. Data-level permissions are highly dependent on the SQL statement being executed. While standard queries require data access (such as `bigquery.tables.getData`), complex operations like DDL or DCL may require permissions to manage reservations, IAM policies, or project settings.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the query request.","schema":{"description":"Required. Project ID of the query request.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_QueryRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_QueryResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/queries/{jobId}":{"get":{"operationId":"bigquery.jobs.getQueryResults","x-executor-toolPath":"bigquery.jobs.getQueryResults","tags":["BigQuery API"],"description":"RPC to get the results of a query job. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.jobs.get` on the job. - `bigquery.tables.getData` on the destination table. If the user matches the creator of the job, the following IAM permission(s) are required instead: - `bigquery.jobs.create` on the project. - `bigquery.tables.getData` on the destination table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the query job.","schema":{"description":"Required. Project ID of the query job.","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the query job.","schema":{"description":"Required. Job ID of the query job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"formatOptions.timestampOutputFormat","in":"query","required":false,"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","schema":{"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","enum":["TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED","FLOAT64","INT64","ISO8601_STRING"],"type":"string"},"style":"form","explode":false},{"name":"formatOptions.useInt64Timestamp","in":"query","required":false,"description":"Optional. Output timestamp as usec int64. Default is false.","schema":{"description":"Optional. Output timestamp as usec int64. Default is false.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","schema":{"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to read.","schema":{"description":"Maximum number of results to read.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results.","schema":{"description":"Page token, returned by a previous call, to request the next page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startIndex","in":"query","required":false,"description":"Zero-based index of the starting row.","schema":{"description":"Zero-based index of the starting row.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"timeoutMs","in":"query","required":false,"description":"Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.","schema":{"description":"Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetQueryResultsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/serviceAccount":{"get":{"operationId":"bigquery.projects.getServiceAccount","x-executor-toolPath":"bigquery.projects.getServiceAccount","tags":["BigQuery API"],"description":"RPC to get the service account for a project used for interactions with Google Cloud KMS. Requires the `bigquery.jobs.create` permission on the project resource. This permission is required to authorize the retrieval of the project's service identity for technical management tasks like encryption configuration.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. ID of the project.","schema":{"description":"Required. ID of the project.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetServiceAccountResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}:getIamPolicy":{"post":{"operationId":"bigquery.routines.getIamPolicy","x-executor-toolPath":"bigquery.routines.getIamPolicy","tags":["BigQuery API"],"description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"routinesId","in":"path","required":true,"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}:setIamPolicy":{"post":{"operationId":"bigquery.routines.setIamPolicy","x-executor-toolPath":"bigquery.routines.setIamPolicy","tags":["BigQuery API"],"description":"Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"routinesId","in":"path","required":true,"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}:testIamPermissions":{"post":{"operationId":"bigquery.routines.testIamPermissions","x-executor-toolPath":"bigquery.routines.testIamPermissions","tags":["BigQuery API"],"description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"routinesId","in":"path","required":true,"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy":{"post":{"operationId":"bigquery.rowAccessPolicies.getIamPolicy","x-executor-toolPath":"bigquery.rowAccessPolicies.getIamPolicy","tags":["BigQuery API"],"description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"rowAccessPoliciesId","in":"path","required":true,"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:testIamPermissions":{"post":{"operationId":"bigquery.rowAccessPolicies.testIamPermissions","x-executor-toolPath":"bigquery.rowAccessPolicies.testIamPermissions","tags":["BigQuery API"],"description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"rowAccessPoliciesId","in":"path","required":true,"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:getIamPolicy":{"post":{"operationId":"bigquery.tables.getIamPolicy","x-executor-toolPath":"bigquery.tables.getIamPolicy","tags":["BigQuery API"],"description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:setIamPolicy":{"post":{"operationId":"bigquery.tables.setIamPolicy","x-executor-toolPath":"bigquery.tables.setIamPolicy","tags":["BigQuery API"],"description":"Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:testIamPermissions":{"post":{"operationId":"bigquery.tables.testIamPermissions","x-executor-toolPath":"bigquery.tables.testIamPermissions","tags":["BigQuery API"],"description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/upload/bigquery/v2/projects/{projectId}/jobs":{"post":{"operationId":"bigquery.jobs.insertMedia","x-executor-toolPath":"bigquery.jobs.insertMedia","tags":["BigQuery API"],"description":"Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts. # IAM Permissions Requires the `bigquery.jobs.create` permission on the project resource. Additional permissions are required depending on the job type: - **Load, Export, and Copy jobs**: Generally require data-level permissions such as `bigquery.tables.export` or access to external storage. - **Query jobs**: Permissions are dependent on the SQL statement. Complex queries (DDL, DCL) may require additional permissions to create reservations, modify IAM policies, or update project settings. (media upload)","parameters":[{"name":"projectId","in":"path","required":true,"description":"Project ID of project that will be billed for the job.","schema":{"description":"Project ID of project that will be billed for the job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"],"servers":[{"url":"https://bigquery.googleapis.com/"}]}}},"components":{"schemas":{"bigquery_v2_AggregateClassificationMetrics":{"description":"Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows.","type":"object","properties":{"accuracy":{"description":"Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.","format":"double","type":"number"},"f1Score":{"description":"The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"logLoss":{"description":"Logarithmic Loss. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"precision":{"description":"Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.","format":"double","type":"number"},"recall":{"description":"Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"rocAuc":{"description":"Area Under a ROC Curve. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"threshold":{"description":"Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold.","format":"double","type":"number"}}},"bigquery_v2_AggregationThresholdPolicy":{"description":"Represents privacy policy associated with \"aggregation threshold\" method.","type":"object","properties":{"privacyUnitColumns":{"description":"Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation (\"outer.inner\")","type":"array","items":{"type":"string"}},"threshold":{"description":"Optional. The threshold for the \"aggregation threshold\" policy.","format":"int64","type":"string"}}},"bigquery_v2_Argument":{"description":"Input/output argument of a function or a stored procedure.","type":"object","properties":{"argumentKind":{"description":"Optional. Defaults to FIXED_TYPE.","enum":["ARGUMENT_KIND_UNSPECIFIED","FIXED_TYPE","ANY_TYPE","FIXED_TABLE","ANY_TABLE"],"type":"string"},"dataType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"isAggregate":{"description":"Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding \"NOT AGGREGATE\" clause in DDL; Otherwise, it is equivalent to omitting \"NOT AGGREGATE\" clause in DDL.","type":"boolean"},"mode":{"description":"Optional. Specifies whether the argument is input or output. Can be set for procedures only.","enum":["MODE_UNSPECIFIED","IN","OUT","INOUT"],"type":"string"},"name":{"description":"Optional. The name of this argument. Can be absent for function return argument.","type":"string"},"tableType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlTableType"}}},"bigquery_v2_ArimaCoefficients":{"description":"Arima coefficients.","type":"object","properties":{"autoRegressiveCoefficients":{"description":"Auto-regressive coefficients, an array of double.","type":"array","items":{"format":"double","type":"number"}},"interceptCoefficient":{"description":"Intercept coefficient, just a double not an array.","format":"double","type":"number"},"movingAverageCoefficients":{"description":"Moving-average coefficients, an array of double.","type":"array","items":{"format":"double","type":"number"}}}},"bigquery_v2_ArimaFittingMetrics":{"description":"ARIMA model fitting metrics.","type":"object","properties":{"aic":{"description":"AIC.","format":"double","type":"number"},"logLikelihood":{"description":"Log-likelihood.","format":"double","type":"number"},"variance":{"description":"Variance.","format":"double","type":"number"}}},"bigquery_v2_ArimaForecastingMetrics":{"description":"Model evaluation metrics for ARIMA forecasting models.","type":"object","properties":{"arimaFittingMetrics":{"description":"Arima model fitting metrics.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaFittingMetrics"}},"arimaSingleModelForecastingMetrics":{"description":"Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaSingleModelForecastingMetrics"}},"hasDrift":{"description":"Whether Arima model fitted with drift or not. It is always false when d is not 1.","type":"array","items":{"type":"boolean"}},"nonSeasonalOrder":{"description":"Non-seasonal order.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"}},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}},"timeSeriesId":{"description":"Id to differentiate different time series for the large-scale case.","type":"array","items":{"type":"string"}}}},"bigquery_v2_ArimaModelInfo":{"description":"Arima model information.","type":"object","properties":{"arimaCoefficients":{"$ref":"#/components/schemas/bigquery_v2_ArimaCoefficients"},"arimaFittingMetrics":{"$ref":"#/components/schemas/bigquery_v2_ArimaFittingMetrics"},"hasDrift":{"description":"Whether Arima model fitted with drift or not. It is always false when d is not 1.","type":"boolean"},"hasHolidayEffect":{"description":"If true, holiday_effect is a part of time series decomposition result.","type":"boolean"},"hasSpikesAndDips":{"description":"If true, spikes_and_dips is a part of time series decomposition result.","type":"boolean"},"hasStepChanges":{"description":"If true, step_changes is a part of time series decomposition result.","type":"boolean"},"nonSeasonalOrder":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}},"timeSeriesId":{"description":"The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.","type":"string"},"timeSeriesIds":{"description":"The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.","type":"array","items":{"type":"string"}}}},"bigquery_v2_ArimaOrder":{"description":"Arima order, can be used for both non-seasonal and seasonal parts.","type":"object","properties":{"d":{"description":"Order of the differencing part.","format":"int64","type":"string"},"p":{"description":"Order of the autoregressive part.","format":"int64","type":"string"},"q":{"description":"Order of the moving-average part.","format":"int64","type":"string"}}},"bigquery_v2_ArimaResult":{"description":"(Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.","type":"object","properties":{"arimaModelInfo":{"description":"This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaModelInfo"}},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}}}},"bigquery_v2_ArimaSingleModelForecastingMetrics":{"description":"Model evaluation metrics for a single ARIMA forecasting model.","type":"object","properties":{"arimaFittingMetrics":{"$ref":"#/components/schemas/bigquery_v2_ArimaFittingMetrics"},"hasDrift":{"description":"Is arima model fitted with drift or not. It is always false when d is not 1.","type":"boolean"},"hasHolidayEffect":{"description":"If true, holiday_effect is a part of time series decomposition result.","type":"boolean"},"hasSpikesAndDips":{"description":"If true, spikes_and_dips is a part of time series decomposition result.","type":"boolean"},"hasStepChanges":{"description":"If true, step_changes is a part of time series decomposition result.","type":"boolean"},"nonSeasonalOrder":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}},"timeSeriesId":{"description":"The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.","type":"string"},"timeSeriesIds":{"description":"The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.","type":"array","items":{"type":"string"}}}},"bigquery_v2_ArrowRecordBatch":{"description":"Arrow RecordBatch. This feature is not yet available.","type":"object","properties":{"serializedRecordBatch":{"description":"IPC-serialized Arrow RecordBatch.","format":"byte","type":"string"}}},"bigquery_v2_ArrowSchema":{"description":"Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available.","type":"object","properties":{"serializedSchema":{"description":"IPC serialized Arrow schema.","format":"byte","type":"string"}}},"bigquery_v2_ArrowSerializationOptions":{"description":"Contains options specific to Arrow Serialization. This feature is not yet available.","type":"object","properties":{"bufferCompression":{"description":"The compression codec to use for Arrow buffers in serialized record batches.","enum":["COMPRESSION_UNSPECIFIED","LZ4_FRAME","ZSTD"],"type":"string"},"picosTimestampPrecision":{"description":"Optional. Set timestamp precision option. If not set, the default precision is microseconds.","enum":["PICOS_TIMESTAMP_PRECISION_UNSPECIFIED","TIMESTAMP_PRECISION_MICROS","TIMESTAMP_PRECISION_NANOS","TIMESTAMP_PRECISION_PICOS"],"type":"string"}}},"bigquery_v2_AuditConfig":{"description":"Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.","type":"object","properties":{"auditLogConfigs":{"description":"The configuration for logging of each type of permission.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_AuditLogConfig"}},"service":{"description":"Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.","type":"string"}}},"bigquery_v2_AuditLogConfig":{"description":"Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.","type":"object","properties":{"exemptedMembers":{"description":"Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.","type":"array","items":{"type":"string"}},"logType":{"description":"The log type that this config enables.","enum":["LOG_TYPE_UNSPECIFIED","ADMIN_READ","DATA_WRITE","DATA_READ"],"type":"string"}}},"bigquery_v2_AvroOptions":{"description":"Options for external data sources.","type":"object","properties":{"useAvroLogicalTypes":{"description":"Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).","type":"boolean"}}},"bigquery_v2_BatchDeleteRowAccessPoliciesRequest":{"description":"Request message for the BatchDeleteRowAccessPoliciesRequest method.","type":"object","properties":{"force":{"description":"If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.","type":"boolean"},"policyIds":{"description":"Required. Policy IDs of the row access policies.","type":"array","items":{"type":"string"}}}},"bigquery_v2_BiEngineReason":{"description":"Reason why BI Engine didn't accelerate the query (or sub-query).","type":"object","properties":{"code":{"description":"Output only. High-level BI Engine reason for partial or disabled acceleration","readOnly":true,"enum":["CODE_UNSPECIFIED","NO_RESERVATION","INSUFFICIENT_RESERVATION","UNSUPPORTED_SQL_TEXT","INPUT_TOO_LARGE","OTHER_REASON","TABLE_EXCLUDED"],"type":"string"},"message":{"description":"Output only. Free form human-readable reason for partial or disabled acceleration.","readOnly":true,"type":"string"}}},"bigquery_v2_BiEngineStatistics":{"description":"Statistics for a BI Engine specific query. Populated as part of JobStatistics2","type":"object","properties":{"accelerationMode":{"description":"Output only. Specifies which mode of BI Engine acceleration was performed (if any).","readOnly":true,"enum":["BI_ENGINE_ACCELERATION_MODE_UNSPECIFIED","BI_ENGINE_DISABLED","PARTIAL_INPUT","FULL_INPUT","FULL_QUERY"],"type":"string"},"biEngineMode":{"description":"Output only. Specifies which mode of BI Engine acceleration was performed (if any).","readOnly":true,"enum":["ACCELERATION_MODE_UNSPECIFIED","DISABLED","PARTIAL","FULL"],"type":"string"},"biEngineReasons":{"description":"In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BiEngineReason"}}}},"bigquery_v2_BigLakeConfiguration":{"description":"Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.)","type":"object","properties":{"connectionId":{"description":"Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}\".","type":"string"},"fileFormat":{"description":"Optional. The file format the table data is stored in.","enum":["FILE_FORMAT_UNSPECIFIED","PARQUET"],"type":"string"},"storageUri":{"description":"Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/`","type":"string"},"tableFormat":{"description":"Optional. The table format the metadata only snapshots are stored in.","enum":["TABLE_FORMAT_UNSPECIFIED","ICEBERG"],"type":"string"}}},"bigquery_v2_BigQueryModelTraining":{"type":"object","properties":{"currentIteration":{"description":"Deprecated.","format":"int32","type":"integer"},"expectedTotalIterations":{"description":"Deprecated.","format":"int64","type":"string"}}},"bigquery_v2_BigtableColumn":{"description":"Information related to a Bigtable column.","type":"object","properties":{"encoding":{"description":"Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. PROTO_BINARY - indicates values are encoded using serialized proto messages. This can only be used in combination with JSON type. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.","type":"string"},"fieldName":{"description":"Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries.","type":"string"},"onlyReadLatest":{"description":"Optional. If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.","type":"boolean"},"protoConfig":{"$ref":"#/components/schemas/bigquery_v2_BigtableProtoConfig"},"qualifierEncoded":{"description":"[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.","format":"byte","type":"string"},"qualifierString":{"description":"Qualifier string.","type":"string"},"type":{"description":"Optional. The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.","type":"string"}}},"bigquery_v2_BigtableColumnFamily":{"description":"Information related to a Bigtable column family.","type":"object","properties":{"columns":{"description":"Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BigtableColumn"}},"encoding":{"description":"Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. PROTO_BINARY - indicates values are encoded using serialized proto messages. This can only be used in combination with JSON type. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.","type":"string"},"familyId":{"description":"Identifier of the column family.","type":"string"},"onlyReadLatest":{"description":"Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.","type":"boolean"},"protoConfig":{"$ref":"#/components/schemas/bigquery_v2_BigtableProtoConfig"},"type":{"description":"Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.","type":"string"}}},"bigquery_v2_BigtableOptions":{"description":"Options specific to Google Cloud Bigtable data sources.","type":"object","properties":{"columnFamilies":{"description":"Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BigtableColumnFamily"}},"ignoreUnspecifiedColumnFamilies":{"description":"Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.","type":"boolean"},"outputColumnFamiliesAsJson":{"description":"Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.","type":"boolean"},"readRowkeyAsString":{"description":"Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.","type":"boolean"}}},"bigquery_v2_BigtableProtoConfig":{"description":"Information related to a Bigtable protobuf column.","type":"object","properties":{"protoMessageName":{"description":"Optional. The fully qualified proto message name of the protobuf. In the format of \"foo.bar.Message\".","type":"string"},"schemaBundleId":{"description":"Optional. The ID of the Bigtable SchemaBundle resource associated with this protobuf. The ID should be referred to within the parent table, e.g., `foo` rather than `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/foo`. See [more details on Bigtable SchemaBundles](https://docs.cloud.google.com/bigtable/docs/create-manage-protobuf-schemas).","type":"string"}}},"bigquery_v2_BinaryClassificationMetrics":{"description":"Evaluation metrics for binary classification/classifier models.","type":"object","properties":{"aggregateClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_AggregateClassificationMetrics"},"binaryConfusionMatrixList":{"description":"Binary confusion matrix at multiple thresholds.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BinaryConfusionMatrix"}},"negativeLabel":{"description":"Label representing the negative class.","type":"string"},"positiveLabel":{"description":"Label representing the positive class.","type":"string"}}},"bigquery_v2_BinaryConfusionMatrix":{"description":"Confusion matrix for binary classification models.","type":"object","properties":{"accuracy":{"description":"The fraction of predictions given the correct label.","format":"double","type":"number"},"f1Score":{"description":"The equally weighted average of recall and precision.","format":"double","type":"number"},"falseNegatives":{"description":"Number of false samples predicted as false.","format":"int64","type":"string"},"falsePositives":{"description":"Number of false samples predicted as true.","format":"int64","type":"string"},"positiveClassThreshold":{"description":"Threshold value used when computing each of the following metric.","format":"double","type":"number"},"precision":{"description":"The fraction of actual positive predictions that had positive actual labels.","format":"double","type":"number"},"recall":{"description":"The fraction of actual positive labels that were given a positive prediction.","format":"double","type":"number"},"trueNegatives":{"description":"Number of true samples predicted as false.","format":"int64","type":"string"},"truePositives":{"description":"Number of true samples predicted as true.","format":"int64","type":"string"}}},"bigquery_v2_Binding":{"description":"Associates `members`, or principals, with a `role`.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/bigquery_v2_Expr"},"members":{"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.","type":"array","items":{"type":"string"}},"role":{"description":"Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).","type":"string"}}},"bigquery_v2_BqmlIterationResult":{"type":"object","properties":{"durationMs":{"description":"Deprecated.","format":"int64","type":"string"},"evalLoss":{"description":"Deprecated.","format":"double","type":"number"},"index":{"description":"Deprecated.","format":"int32","type":"integer"},"learnRate":{"description":"Deprecated.","format":"double","type":"number"},"trainingLoss":{"description":"Deprecated.","format":"double","type":"number"}}},"bigquery_v2_BqmlTrainingRun":{"type":"object","properties":{"iterationResults":{"description":"Deprecated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BqmlIterationResult"}},"startTime":{"description":"Deprecated.","format":"date-time","type":"string"},"state":{"description":"Deprecated.","type":"string"},"trainingOptions":{"description":"Deprecated.","type":"object","properties":{"earlyStop":{"type":"boolean"},"l1Reg":{"format":"double","type":"number"},"l2Reg":{"format":"double","type":"number"},"learnRate":{"format":"double","type":"number"},"learnRateStrategy":{"type":"string"},"lineSearchInitLearnRate":{"format":"double","type":"number"},"maxIteration":{"format":"int64","type":"string"},"minRelProgress":{"format":"double","type":"number"},"warmStart":{"type":"boolean"}}}}},"bigquery_v2_CategoricalValue":{"description":"Representative value of a categorical feature.","type":"object","properties":{"categoryCounts":{"description":"Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category \"_OTHER_\" and count as aggregate counts of remaining categories.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_CategoryCount"}}}},"bigquery_v2_CategoryCount":{"description":"Represents the count of a single category within the cluster.","type":"object","properties":{"category":{"description":"The name of category.","type":"string"},"count":{"description":"The count of training samples matching the category within the cluster.","format":"int64","type":"string"}}},"bigquery_v2_CloneDefinition":{"description":"Information about base table and clone time of a table clone.","type":"object","properties":{"baseTableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"cloneTime":{"description":"Required. The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.","format":"date-time","type":"string"}}},"bigquery_v2_Cluster":{"description":"Message containing the information about one cluster.","type":"object","properties":{"centroidId":{"description":"Centroid id.","format":"int64","type":"string"},"count":{"description":"Count of training data rows that were assigned to this cluster.","format":"int64","type":"string"},"featureValues":{"description":"Values of highly variant features for this cluster.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_FeatureValue"}}}},"bigquery_v2_ClusterInfo":{"description":"Information about a single cluster for clustering model.","type":"object","properties":{"centroidId":{"description":"Centroid id.","format":"int64","type":"string"},"clusterRadius":{"description":"Cluster radius, the average distance from centroid to each point assigned to the cluster.","format":"double","type":"number"},"clusterSize":{"description":"Cluster size, the total number of points assigned to the cluster.","format":"int64","type":"string"}}},"bigquery_v2_Clustering":{"description":"Configures table clustering.","type":"object","properties":{"fields":{"description":"One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations).","type":"array","items":{"type":"string"}}}},"bigquery_v2_ClusteringMetrics":{"description":"Evaluation metrics for clustering models.","type":"object","properties":{"clusters":{"description":"Information for all clusters.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Cluster"}},"daviesBouldinIndex":{"description":"Davies-Bouldin index.","format":"double","type":"number"},"meanSquaredDistance":{"description":"Mean of squared distances between each sample to its cluster centroid.","format":"double","type":"number"}}},"bigquery_v2_ConfusionMatrix":{"description":"Confusion matrix for multi-class classification models.","type":"object","properties":{"confidenceThreshold":{"description":"Confidence threshold used when computing the entries of the confusion matrix.","format":"double","type":"number"},"rows":{"description":"One row per actual label.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Row"}}}},"bigquery_v2_ConnectionProperty":{"description":"A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration * **service_account**: indicates the service account to use to run a continuous query. If set, the query job uses the service account to access Google Cloud resources. Service account access is bounded by the IAM permissions that you have granted to the service account. Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.","type":"object","properties":{"key":{"description":"The key of the property to set.","type":"string"},"value":{"description":"The value of the property to set.","type":"string"}}},"bigquery_v2_CsvOptions":{"description":"Information related to a CSV data source.","type":"object","properties":{"allowJaggedRows":{"description":"Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.","type":"boolean"},"allowQuotedNewlines":{"description":"Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.","type":"boolean"},"encoding":{"description":"Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.","type":"string"},"fieldDelimiter":{"description":"Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence \"\\t\" (U+0009) to specify a tab separator. The default value is comma (\",\", U+002C).","type":"string"},"nullMarker":{"description":"Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.","type":"string"},"nullMarkers":{"description":"Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.","type":"array","items":{"type":"string"}},"preserveAsciiControlCharacters":{"description":"Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\\x00' to '\\x1F') are preserved.","type":"boolean"},"quote":{"description":"Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (\"). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' \" ', use ' \"\" '.","default":"\"","type":"string"},"skipLeadingRows":{"description":"Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.","format":"int64","type":"string"},"sourceColumnMatch":{"description":"Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. Acceptable values are: POSITION - matches by position. This assumes that the columns are ordered the same way as the schema. NAME - matches by name. This reads the header row as column names and reorders columns to match the field names in the schema.","type":"string"}}},"bigquery_v2_DataFormatOptions":{"description":"Options for data format adjustments.","type":"object","properties":{"timestampOutputFormat":{"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","enum":["TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED","FLOAT64","INT64","ISO8601_STRING"],"type":"string"},"useInt64Timestamp":{"description":"Optional. Output timestamp as usec int64. Default is false.","type":"boolean"}}},"bigquery_v2_DataMaskingStatistics":{"description":"Statistics for data-masking.","type":"object","properties":{"dataMaskingApplied":{"description":"Whether any accessed data was protected by the data masking.","type":"boolean"}}},"bigquery_v2_DataPolicyList":{"description":"A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).","type":"object","properties":{"dataPolicies":{"description":"Contains a list of data policy options. At most 9 data policies are allowed per field.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_DataPolicyOption"}}}},"bigquery_v2_DataPolicyOption":{"description":"Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).","type":"object","properties":{"name":{"description":"Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.","type":"string"}}},"bigquery_v2_DataSplitResult":{"description":"Data split result. This contains references to the training and evaluation data tables that were used to train the model.","type":"object","properties":{"evaluationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"testTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"trainingTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_Dataset":{"description":"Represents a BigQuery dataset.","type":"object","properties":{"access":{"description":"Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.","type":"array","items":{"description":"An object that defines dataset access for an entity.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/bigquery_v2_Expr"},"dataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetAccessEntry"},"domain":{"description":"[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\". Maps to IAM policy member \"domain:DOMAIN\".","type":"string"},"groupByEmail":{"description":"[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member \"group:GROUP\".","type":"string"},"iamMember":{"description":"[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.","type":"string"},"role":{"description":"An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".","type":"string"},"routine":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"},"specialGroup":{"description":"[Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.","type":"string"},"userByEmail":{"description":"[Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member \"user:EMAIL\" or \"serviceAccount:EMAIL\".","type":"string"},"view":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}}},"catalogSource":{"description":"Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake","readOnly":true,"type":"string"},"creationTime":{"description":"Output only. The time when this dataset was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"datasetReference":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"defaultCollation":{"description":"Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.","type":"string"},"defaultEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"defaultPartitionExpirationMs":{"description":"This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline.","format":"int64","type":"string"},"defaultRoundingMode":{"description":"Optional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table's default rounding mode, unless otherwise specified.","enum":["ROUNDING_MODE_UNSPECIFIED","ROUND_HALF_AWAY_FROM_ZERO","ROUND_HALF_EVEN"],"type":"string"},"defaultTableExpirationMs":{"description":"Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.","format":"int64","type":"string"},"description":{"description":"Optional. A user-friendly description of the dataset.","type":"string"},"etag":{"description":"Output only. A hash of the resource.","readOnly":true,"type":"string"},"externalCatalogDatasetOptions":{"$ref":"#/components/schemas/bigquery_v2_ExternalCatalogDatasetOptions"},"externalDatasetReference":{"$ref":"#/components/schemas/bigquery_v2_ExternalDatasetReference"},"friendlyName":{"description":"Optional. A descriptive name for the dataset.","type":"string"},"id":{"description":"Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.","readOnly":true,"type":"string"},"isCaseInsensitive":{"description":"Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.","type":"boolean"},"kind":{"description":"Output only. The resource type.","readOnly":true,"default":"bigquery#dataset","type":"string"},"labels":{"description":"The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See [Creating and Updating Dataset Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) for more information.","type":"object","additionalProperties":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The date when this dataset was last modified, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"linkedDatasetMetadata":{"$ref":"#/components/schemas/bigquery_v2_LinkedDatasetMetadata"},"linkedDatasetSource":{"$ref":"#/components/schemas/bigquery_v2_LinkedDatasetSource"},"location":{"description":"The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.","type":"string"},"maxTimeTravelHours":{"description":"Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.","format":"int64","type":"string"},"resourceTags":{"description":"Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"123456789012/environment\" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"Production\". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details.","type":"object","additionalProperties":{"type":"string"}},"restrictions":{"$ref":"#/components/schemas/bigquery_v2_RestrictionConfig"},"satisfiesPzi":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"satisfiesPzs":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"selfLink":{"description":"Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.","readOnly":true,"type":"string"},"storageBillingModel":{"description":"Optional. Updates storage_billing_model for the dataset.","enum":["STORAGE_BILLING_MODEL_UNSPECIFIED","LOGICAL","PHYSICAL"],"type":"string"},"tags":{"description":"Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.","readOnly":true,"type":"array","items":{"description":"A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions","type":"object","properties":{"tagKey":{"description":"Required. The namespaced friendly name of the tag key, e.g. \"12345/environment\" where 12345 is org id.","type":"string"},"tagValue":{"description":"Required. The friendly short name of the tag value, e.g. \"production\".","type":"string"}}}},"type":{"description":"Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API.","readOnly":true,"type":"string"}}},"bigquery_v2_DatasetAccessEntry":{"description":"Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset.","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"targetTypes":{"description":"Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future.","type":"array","items":{"enum":["TARGET_TYPE_UNSPECIFIED","VIEWS","ROUTINES"],"type":"string"}}}},"bigquery_v2_DatasetList":{"description":"Response format for a page of results when listing datasets.","type":"object","properties":{"datasets":{"description":"An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.","type":"array","items":{"description":"A dataset resource with only a subset of fields, to be returned in a list of datasets.","type":"object","properties":{"catalogSource":{"description":"Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset. * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake.","readOnly":true,"type":"string"},"datasetReference":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"externalDatasetReference":{"$ref":"#/components/schemas/bigquery_v2_ExternalDatasetReference"},"friendlyName":{"description":"An alternate name for the dataset. The friendly name is purely decorative in nature.","type":"string"},"id":{"description":"The fully-qualified, unique, opaque ID of the dataset.","type":"string"},"kind":{"description":"The resource type. This property always returns the value \"bigquery#dataset\"","type":"string"},"labels":{"description":"The labels associated with this dataset. You can use these to organize and group your datasets.","type":"object","additionalProperties":{"type":"string"}},"location":{"description":"The geographic location where the dataset resides.","type":"string"},"type":{"description":"Output only. Same as `type` in `Dataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API.","readOnly":true,"type":"string"}}}},"etag":{"description":"Output only. A hash value of the results page. You can use this property to determine if the page has changed since the last request.","readOnly":true,"type":"string"},"kind":{"description":"Output only. The resource type. This property always returns the value \"bigquery#datasetList\"","readOnly":true,"default":"bigquery#datasetList","type":"string"},"nextPageToken":{"description":"A token that can be used to request the next results page. This property is omitted on the final results page.","type":"string"},"unreachable":{"description":"A list of skipped locations that were unreachable. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations. Example: \"europe-west5\"","type":"array","items":{"type":"string"}}}},"bigquery_v2_DatasetReference":{"description":"Identifier for a dataset.","type":"object","properties":{"datasetId":{"description":"Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.","type":"string"},"projectId":{"description":"Optional. The ID of the project containing this dataset.","type":"string"}}},"bigquery_v2_DestinationTableProperties":{"description":"Properties for the destination table.","type":"object","properties":{"description":{"description":"Optional. The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.","type":"string"},"expirationTime":{"description":"Internal use only.","format":"date-time","type":"string"},"friendlyName":{"description":"Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.","type":"string"},"labels":{"description":"Optional. The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.","type":"object","additionalProperties":{"type":"string"}}}},"bigquery_v2_DifferentialPrivacyPolicy":{"description":"Represents privacy policy associated with \"differential privacy\" method.","type":"object","properties":{"deltaBudget":{"description":"Optional. The total delta budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of delta that is pre-defined by the contributor through the privacy policy delta_per_query field. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.","format":"double","type":"number"},"deltaBudgetRemaining":{"description":"Output only. The delta budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.","format":"double","readOnly":true,"type":"number"},"deltaPerQuery":{"description":"Optional. The delta value that is used per query. Delta represents the probability that any row will fail to be epsilon differentially private. Indicates the risk associated with exposing aggregate rows in the result of a query.","format":"double","type":"number"},"epsilonBudget":{"description":"Optional. The total epsilon budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of epsilon they request in their query. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.","format":"double","type":"number"},"epsilonBudgetRemaining":{"description":"Output only. The epsilon budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.","format":"double","readOnly":true,"type":"number"},"maxEpsilonPerQuery":{"description":"Optional. The maximum epsilon value that a query can consume. If the subscriber specifies epsilon as a parameter in a SELECT query, it must be less than or equal to this value. The epsilon parameter controls the amount of noise that is added to the groups — a higher epsilon means less noise.","format":"double","type":"number"},"maxGroupsContributed":{"description":"Optional. The maximum groups contributed value that is used per query. Represents the maximum number of groups to which each protected entity can contribute. Changing this value does not improve or worsen privacy. The best value for accuracy and utility depends on the query and data.","format":"int64","type":"string"},"privacyUnitColumn":{"description":"Optional. The privacy unit column associated with this policy. Differential privacy policies can only have one privacy unit column per data source object (table, view).","type":"string"}}},"bigquery_v2_DimensionalityReductionMetrics":{"description":"Model evaluation metrics for dimensionality reduction models.","type":"object","properties":{"totalExplainedVarianceRatio":{"description":"Total percentage of variance explained by the selected principal components.","format":"double","type":"number"}}},"bigquery_v2_DmlStatistics":{"description":"Detailed statistics for DML statements","type":"object","properties":{"deletedRowCount":{"description":"Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.","format":"int64","readOnly":true,"type":"string"},"dmlMode":{"description":"Output only. DML mode used.","readOnly":true,"enum":["DML_MODE_UNSPECIFIED","COARSE_GRAINED_DML","FINE_GRAINED_DML"],"type":"string"},"fineGrainedDmlUnusedReason":{"description":"Output only. Reason for disabling fine-grained DML if applicable.","readOnly":true,"enum":["FINE_GRAINED_DML_UNUSED_REASON_UNSPECIFIED","MAX_PARTITION_SIZE_EXCEEDED","TABLE_NOT_ENROLLED","DML_IN_MULTI_STATEMENT_TRANSACTION"],"type":"string"},"insertedRowCount":{"description":"Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements","format":"int64","readOnly":true,"type":"string"},"updatedRowCount":{"description":"Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_DoubleCandidates":{"description":"Discrete candidates of a double hyperparameter.","type":"object","properties":{"candidates":{"description":"Candidates for the double parameter in increasing order.","type":"array","items":{"format":"double","type":"number"}}}},"bigquery_v2_DoubleHparamSearchSpace":{"description":"Search space for a double hyperparameter.","type":"object","properties":{"candidates":{"$ref":"#/components/schemas/bigquery_v2_DoubleCandidates"},"range":{"$ref":"#/components/schemas/bigquery_v2_DoubleRange"}}},"bigquery_v2_DoubleRange":{"description":"Range of a double hyperparameter.","type":"object","properties":{"max":{"description":"Max value of the double parameter.","format":"double","type":"number"},"min":{"description":"Min value of the double parameter.","format":"double","type":"number"}}},"bigquery_v2_EncryptionConfiguration":{"description":"Configuration for Cloud KMS encryption settings.","type":"object","properties":{"kmsKeyName":{"description":"Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.","type":"string"}}},"bigquery_v2_Entry":{"description":"A single entry in the confusion matrix.","type":"object","properties":{"itemCount":{"description":"Number of items being predicted as this label.","format":"int64","type":"string"},"predictedLabel":{"description":"The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.","type":"string"}}},"bigquery_v2_ErrorProto":{"description":"Error details.","type":"object","properties":{"debugInfo":{"description":"Debugging information. This property is internal to Google and should not be used.","type":"string"},"location":{"description":"Specifies where the error occurred, if present.","type":"string"},"message":{"description":"A human-readable description of the error.","type":"string"},"reason":{"description":"A short error code that summarizes the error.","type":"string"}}},"bigquery_v2_EvaluationMetrics":{"description":"Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.","type":"object","properties":{"arimaForecastingMetrics":{"$ref":"#/components/schemas/bigquery_v2_ArimaForecastingMetrics"},"binaryClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_BinaryClassificationMetrics"},"clusteringMetrics":{"$ref":"#/components/schemas/bigquery_v2_ClusteringMetrics"},"dimensionalityReductionMetrics":{"$ref":"#/components/schemas/bigquery_v2_DimensionalityReductionMetrics"},"multiClassClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_MultiClassClassificationMetrics"},"rankingMetrics":{"$ref":"#/components/schemas/bigquery_v2_RankingMetrics"},"regressionMetrics":{"$ref":"#/components/schemas/bigquery_v2_RegressionMetrics"}}},"bigquery_v2_ExplainQueryStage":{"description":"A single stage of query execution.","type":"object","properties":{"completedParallelInputs":{"description":"Number of parallel input segments completed.","format":"int64","type":"string"},"computeMode":{"description":"Output only. Compute mode for this stage.","readOnly":true,"enum":["COMPUTE_MODE_UNSPECIFIED","BIGQUERY","BI_ENGINE"],"type":"string"},"computeMsAvg":{"description":"Milliseconds the average shard spent on CPU-bound tasks.","format":"int64","type":"string"},"computeMsMax":{"description":"Milliseconds the slowest shard spent on CPU-bound tasks.","format":"int64","type":"string"},"computeRatioAvg":{"description":"Relative amount of time the average shard spent on CPU-bound tasks.","format":"double","type":"number"},"computeRatioMax":{"description":"Relative amount of time the slowest shard spent on CPU-bound tasks.","format":"double","type":"number"},"endMs":{"description":"Stage end time represented as milliseconds since the epoch.","format":"int64","type":"string"},"id":{"description":"Unique ID for the stage within the plan.","format":"int64","type":"string"},"inputStages":{"description":"IDs for stages that are inputs to this stage.","type":"array","items":{"format":"int64","type":"string"}},"name":{"description":"Human-readable name for the stage.","type":"string"},"parallelInputs":{"description":"Number of parallel input segments to be processed","format":"int64","type":"string"},"readMsAvg":{"description":"Milliseconds the average shard spent reading input.","format":"int64","type":"string"},"readMsMax":{"description":"Milliseconds the slowest shard spent reading input.","format":"int64","type":"string"},"readRatioAvg":{"description":"Relative amount of time the average shard spent reading input.","format":"double","type":"number"},"readRatioMax":{"description":"Relative amount of time the slowest shard spent reading input.","format":"double","type":"number"},"recordsRead":{"description":"Number of records read into the stage.","format":"int64","type":"string"},"recordsWritten":{"description":"Number of records written by the stage.","format":"int64","type":"string"},"shuffleOutputBytes":{"description":"Total number of bytes written to shuffle.","format":"int64","type":"string"},"shuffleOutputBytesSpilled":{"description":"Total number of bytes written to shuffle and spilled to disk.","format":"int64","type":"string"},"slotMs":{"description":"Slot-milliseconds used by the stage.","format":"int64","type":"string"},"startMs":{"description":"Stage start time represented as milliseconds since the epoch.","format":"int64","type":"string"},"status":{"description":"Current status for this stage.","type":"string"},"steps":{"description":"List of operations within the stage in dependency order (approximately chronological).","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExplainQueryStep"}},"waitMsAvg":{"description":"Milliseconds the average shard spent waiting to be scheduled.","format":"int64","type":"string"},"waitMsMax":{"description":"Milliseconds the slowest shard spent waiting to be scheduled.","format":"int64","type":"string"},"waitRatioAvg":{"description":"Relative amount of time the average shard spent waiting to be scheduled.","format":"double","type":"number"},"waitRatioMax":{"description":"Relative amount of time the slowest shard spent waiting to be scheduled.","format":"double","type":"number"},"writeMsAvg":{"description":"Milliseconds the average shard spent on writing output.","format":"int64","type":"string"},"writeMsMax":{"description":"Milliseconds the slowest shard spent on writing output.","format":"int64","type":"string"},"writeRatioAvg":{"description":"Relative amount of time the average shard spent on writing output.","format":"double","type":"number"},"writeRatioMax":{"description":"Relative amount of time the slowest shard spent on writing output.","format":"double","type":"number"}}},"bigquery_v2_ExplainQueryStep":{"description":"An operation within a stage.","type":"object","properties":{"kind":{"description":"Machine-readable operation type.","type":"string"},"substeps":{"description":"Human-readable description of the step(s).","type":"array","items":{"type":"string"}}}},"bigquery_v2_Explanation":{"description":"Explanation for a single feature.","type":"object","properties":{"attribution":{"description":"Attribution of feature.","format":"double","type":"number"},"featureName":{"description":"The full feature name. For non-numerical features, will be formatted like `.`. Overall size of feature name will always be truncated to first 120 characters.","type":"string"}}},"bigquery_v2_ExportDataStatistics":{"description":"Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4.","type":"object","properties":{"fileCount":{"description":"Number of destination files generated in case of EXPORT DATA statement only.","format":"int64","type":"string"},"rowCount":{"description":"[Alpha] Number of destination rows generated in case of EXPORT DATA statement only.","format":"int64","type":"string"}}},"bigquery_v2_Expr":{"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.","type":"object","properties":{"description":{"description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.","type":"string"},"expression":{"description":"Textual representation of an expression in Common Expression Language syntax.","type":"string"},"location":{"description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.","type":"string"},"title":{"description":"Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.","type":"string"}}},"bigquery_v2_ExternalCatalogDatasetOptions":{"description":"Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema, or namespace represented by the current dataset.","type":"object","properties":{"defaultStorageLocationUri":{"description":"Optional. The storage location URI for all tables in the dataset. Equivalent to hive metastore's database locationUri. Maximum length of 1024 characters.","type":"string"},"parameters":{"description":"Optional. A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of 2MiB.","type":"object","additionalProperties":{"type":"string"}}}},"bigquery_v2_ExternalCatalogTableOptions":{"description":"Metadata about open source compatible table. The fields contained in these options correspond to Hive metastore's table-level properties.","type":"object","properties":{"connectionId":{"description":"Optional. A connection ID that specifies the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or Amazon S3. This connection is needed to read the open source table from BigQuery. The connection_id format must be either `..` or `projects//locations//connections/`.","type":"string"},"parameters":{"description":"Optional. A map of the key-value pairs defining the parameters and properties of the open source table. Corresponds with Hive metastore table parameters. Maximum size of 4MiB.","type":"object","additionalProperties":{"type":"string"}},"storageDescriptor":{"$ref":"#/components/schemas/bigquery_v2_StorageDescriptor"}}},"bigquery_v2_ExternalDataConfiguration":{"type":"object","properties":{"autodetect":{"description":"Try to detect schema and format options automatically. Any option specified explicitly will be honored.","type":"boolean"},"avroOptions":{"$ref":"#/components/schemas/bigquery_v2_AvroOptions"},"bigtableOptions":{"$ref":"#/components/schemas/bigquery_v2_BigtableOptions"},"compression":{"description":"Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.","type":"string"},"connectionId":{"description":"Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form `{project_id}.{location_id};{connection_id}` or `projects/{project_id}/locations/{location_id}/connections/{connection_id}`.","type":"string"},"csvOptions":{"$ref":"#/components/schemas/bigquery_v2_CsvOptions"},"dateFormat":{"description":"Optional. Format used to parse DATE values. Supports C-style and SQL-style values.","type":"string"},"datetimeFormat":{"description":"Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values.","type":"string"},"decimalTargetTypes":{"description":"Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.","type":"array","items":{"enum":["DECIMAL_TARGET_TYPE_UNSPECIFIED","NUMERIC","BIGNUMERIC","STRING"],"type":"string"}},"fileSetSpecType":{"description":"Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.","enum":["FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH","FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST"],"type":"string"},"googleSheetsOptions":{"$ref":"#/components/schemas/bigquery_v2_GoogleSheetsOptions"},"hivePartitioningOptions":{"$ref":"#/components/schemas/bigquery_v2_HivePartitioningOptions"},"ignoreUnknownValues":{"description":"Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.","type":"boolean"},"jsonExtension":{"description":"Optional. Load option to be used together with source_format newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and source_format must be set to NEWLINE_DELIMITED_JSON).","enum":["JSON_EXTENSION_UNSPECIFIED","GEOJSON"],"type":"string"},"jsonOptions":{"$ref":"#/components/schemas/bigquery_v2_JsonOptions"},"maxBadRecords":{"description":"Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.","format":"int32","type":"integer"},"metadataCacheMode":{"description":"Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.","enum":["METADATA_CACHE_MODE_UNSPECIFIED","AUTOMATIC","MANUAL"],"type":"string"},"objectMetadata":{"description":"Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.","enum":["OBJECT_METADATA_UNSPECIFIED","DIRECTORY","SIMPLE"],"type":"string"},"parquetOptions":{"$ref":"#/components/schemas/bigquery_v2_ParquetOptions"},"referenceFileSchemaUri":{"description":"Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.","type":"string"},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"sourceFormat":{"description":"[Required] The data format. For CSV files, specify \"CSV\". For Google sheets, specify \"GOOGLE_SHEETS\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro files, specify \"AVRO\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\". For Apache Iceberg tables, specify \"ICEBERG\". For ORC files, specify \"ORC\". For Parquet files, specify \"PARQUET\". [Beta] For Google Cloud Bigtable, specify \"BIGTABLE\".","type":"string"},"sourceUris":{"description":"[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.","type":"array","items":{"type":"string"}},"timeFormat":{"description":"Optional. Format used to parse TIME values. Supports C-style and SQL-style values.","type":"string"},"timeZone":{"description":"Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles).","type":"string"},"timestampFormat":{"description":"Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.","type":"string"},"timestampTargetPrecision":{"description":"Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, AVRO, and Iceberg External Table. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.","type":"array","items":{"format":"int32","type":"integer"}}}},"bigquery_v2_ExternalDatasetReference":{"description":"Configures the access a dataset defined in an external metadata storage.","type":"object","properties":{"connection":{"description":"Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}","type":"string"},"externalSource":{"description":"Required. External source that backs this dataset.","type":"string"}}},"bigquery_v2_ExternalRuntimeOptions":{"description":"Options for the runtime of the external system.","type":"object","properties":{"containerCpu":{"description":"Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits)","format":"double","type":"number"},"containerMemory":{"description":"Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of \"M\", \"G\", \"Mi\" and \"Gi\" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits)","type":"string"},"containerRequestConcurrency":{"description":"Optional. Maximum number of requests that a Python UDF instance can handle concurrently. If absent or if `0`, the default concurrency value is used. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits).","format":"int64","type":"string"},"maxBatchingRows":{"description":"Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.","format":"int64","type":"string"},"runtimeConnection":{"description":"Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```\"projects/{project_id}/locations/{location_id}/connections/{connection_id}\"```","type":"string"},"runtimeVersion":{"description":"Optional. Language runtime version. Example: `python-3.11`.","type":"string"},"volumeMounts":{"description":"Optional. List of volume mounts for the Python UDF container that executes the managed function.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExternalVolumeMount"}}}},"bigquery_v2_ExternalServiceCost":{"description":"The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.","type":"object","properties":{"billingMethod":{"description":"The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility.","type":"string"},"bytesBilled":{"description":"External service cost in terms of bigquery bytes billed.","format":"int64","type":"string"},"bytesProcessed":{"description":"External service cost in terms of bigquery bytes processed.","format":"int64","type":"string"},"externalService":{"description":"External service name.","type":"string"},"reservedSlotCount":{"description":"Non-preemptable reserved slots used for external job. For example, reserved slots for Cloua AI Platform job are the VM usages converted to BigQuery slot with equivalent mount of price.","format":"int64","type":"string"},"slotMs":{"description":"External service cost in terms of bigquery slot milliseconds.","format":"int64","type":"string"}}},"bigquery_v2_ExternalVolumeMount":{"description":"Configuration of a volume mount for the Python UDF container that executes the managed function.","type":"object","properties":{"mountPath":{"description":"Optional. The absolute path within the container where the volume should be mounted.","type":"string"},"sourcePath":{"description":"Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder.","type":"string"}}},"bigquery_v2_FeatureValue":{"description":"Representative value of a single feature within the cluster.","type":"object","properties":{"categoricalValue":{"$ref":"#/components/schemas/bigquery_v2_CategoricalValue"},"featureColumn":{"description":"The feature column name.","type":"string"},"numericalValue":{"description":"The numerical feature value. This is the centroid value for this feature.","format":"double","type":"number"}}},"bigquery_v2_ForeignTypeInfo":{"description":"Metadata about the foreign data type definition such as the system in which the type is defined.","type":"object","properties":{"typeSystem":{"description":"Required. Specifies the system which defines the foreign data type.","enum":["TYPE_SYSTEM_UNSPECIFIED","HIVE"],"type":"string"}}},"bigquery_v2_ForeignViewDefinition":{"description":"A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations.","type":"object","properties":{"dialect":{"description":"Optional. Represents the dialect of the query.","type":"string"},"query":{"description":"Required. The query that defines the view.","type":"string"}}},"bigquery_v2_GenAiErrorStats":{"description":"Provides error statistics for the query job across all AI function calls.","type":"object","properties":{"errors":{"description":"A list of unique errors at query level (up to 5, truncated to 100 chars)","type":"array","items":{"type":"string"}}}},"bigquery_v2_GenAiFunctionCacheStats":{"description":"Provides cache statistics for a GenAi function call.","type":"object","properties":{"numCacheHitRows":{"description":"Number of rows served from cache.","format":"int64","type":"string"}}},"bigquery_v2_GenAiFunctionCostOptimizationStats":{"description":"Provides cost optimization statistics for a GenAi function call.","type":"object","properties":{"message":{"description":"System generated message to provide insights into cost optimization state.","type":"string"},"numCostOptimizedRows":{"description":"Number of rows inferred via cost optimized workflow.","format":"int64","type":"string"}}},"bigquery_v2_GenAiFunctionErrorStats":{"description":"Provides error statistics for a GenAi function call.","type":"object","properties":{"errors":{"description":"A list of unique errors at function level (up to 5, truncated to 100 chars).","type":"array","items":{"type":"string"}},"numFailedRows":{"description":"Number of failed rows processed by the function","format":"int64","type":"string"}}},"bigquery_v2_GenAiFunctionStats":{"description":"Provides statistics for each Ai function call within a query.","type":"object","properties":{"cacheStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionCacheStats"},"costOptimizationStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionCostOptimizationStats"},"errorStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionErrorStats"},"functionName":{"description":"Name of the function.","type":"string"},"numProcessedRows":{"description":"Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows.","format":"int64","type":"string"},"prompt":{"description":"User input prompt of the function (truncated to 20 chars).","type":"string"}}},"bigquery_v2_GenAiStats":{"description":"GenAi stats for the query job.","type":"object","properties":{"errorStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiErrorStats"},"functionStats":{"description":"Function level stats for GenAI Functions. For more information, see [Generative AI overview](https://docs.cloud.google.com/bigquery/docs/generative-ai-overview).","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionStats"}}}},"bigquery_v2_GeneratedColumn":{"description":"Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields).","type":"object","properties":{"generatedExpressionInfo":{"$ref":"#/components/schemas/bigquery_v2_GeneratedExpressionInfo"},"generatedMode":{"description":"Optional. Dictates when system generated values are used to populate the field.","enum":["GENERATED_MODE_UNSPECIFIED","GENERATED_ALWAYS","GENERATED_BY_DEFAULT"],"type":"string"}}},"bigquery_v2_GeneratedExpressionInfo":{"description":"Definition of the expression used to generate the field.","type":"object","properties":{"asynchronous":{"description":"Optional. Whether the column generation is done asynchronously.","type":"boolean"},"generationExpression":{"description":"Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field.","type":"string"},"stored":{"description":"Optional. Whether the generated column is stored in the table.","type":"boolean"}}},"bigquery_v2_GetIamPolicyRequest":{"description":"Request message for `GetIamPolicy` method.","type":"object","properties":{"options":{"$ref":"#/components/schemas/bigquery_v2_GetPolicyOptions"}}},"bigquery_v2_GetPolicyOptions":{"description":"Encapsulates settings provided to GetIamPolicy.","type":"object","properties":{"requestedPolicyVersion":{"description":"Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"bigquery_v2_GetQueryResultsResponse":{"description":"Response object of GetQueryResults.","type":"object","properties":{"cacheHit":{"description":"Whether the query result was fetched from the query cache.","type":"boolean"},"errors":{"description":"Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"etag":{"description":"A hash of this response.","type":"string"},"jobComplete":{"description":"Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.","type":"boolean"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"The resource type of the response.","default":"bigquery#getQueryResultsResponse","type":"string"},"numDmlAffectedRows":{"description":"Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.","format":"int64","readOnly":true,"type":"string"},"pageToken":{"description":"A token used for paging results. When this token is non-empty, it indicates additional results are available.","type":"string"},"rows":{"description":"An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. The REST-based representation of this data leverages a series of JSON f,v objects for indicating fields and values.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableRow"}},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"totalBytesProcessed":{"description":"The total number of bytes processed for this query.","format":"int64","type":"string"},"totalRows":{"description":"The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.","format":"uint64","type":"string"}}},"bigquery_v2_GetServiceAccountResponse":{"description":"Response object of GetServiceAccount","type":"object","properties":{"email":{"description":"The service account email address.","type":"string"},"kind":{"description":"The resource type of the response.","default":"bigquery#getServiceAccountResponse","type":"string"}}},"bigquery_v2_GlobalExplanation":{"description":"Global explanations containing the top most important features after training.","type":"object","properties":{"classLabel":{"description":"Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.","type":"string"},"explanations":{"description":"A list of the top global explanations. Sorted by absolute value of attribution in descending order.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Explanation"}}}},"bigquery_v2_GoogleSheetsOptions":{"description":"Options specific to Google Sheets data sources.","type":"object","properties":{"range":{"description":"Optional. Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20","type":"string"},"skipLeadingRows":{"description":"Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.","format":"int64","type":"string"}}},"bigquery_v2_HighCardinalityJoin":{"description":"High cardinality join detailed information.","type":"object","properties":{"leftRows":{"description":"Output only. Count of left input rows.","format":"int64","readOnly":true,"type":"string"},"outputRows":{"description":"Output only. Count of the output rows.","format":"int64","readOnly":true,"type":"string"},"rightRows":{"description":"Output only. Count of right input rows.","format":"int64","readOnly":true,"type":"string"},"stepIndex":{"description":"Output only. The index of the join operator in the ExplainQueryStep lists.","format":"int32","readOnly":true,"type":"integer"}}},"bigquery_v2_HivePartitioningOptions":{"description":"Options for configuring hive partitioning detect.","type":"object","properties":{"fields":{"description":"Output only. For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.","readOnly":true,"type":"array","items":{"type":"string"}},"mode":{"description":"Optional. When set, what mode of hive partitioning to use when reading data. The following modes are supported: * AUTO: automatically infer partition key name(s) and type(s). * STRINGS: automatically infer partition key name(s). All types are strings. * CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported formats are: JSON, CSV, ORC, Avro and Parquet.","type":"string"},"requirePartitionFilter":{"description":"Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.","default":false,"type":"boolean"},"sourceUriPrefix":{"description":"Optional. When hive partition detection is requested, a common prefix for all source uris must be required. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout: gs://bucket/path_to_table/dt=2019-06-01/country=USA/id=7/file.avro gs://bucket/path_to_table/dt=2019-05-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/. CUSTOM detection requires encoding the partitioning schema immediately after the common prefix. For CUSTOM, any of * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:STRING}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:STRING} would all be valid source URI prefixes.","type":"string"}}},"bigquery_v2_HparamSearchSpaces":{"description":"Hyperparameter search spaces. These should be a subset of training_options.","type":"object","properties":{"activationFn":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"batchSize":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"boosterType":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"colsampleBylevel":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"colsampleBynode":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"colsampleBytree":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"dartNormalizeType":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"dropout":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"hiddenUnits":{"$ref":"#/components/schemas/bigquery_v2_IntArrayHparamSearchSpace"},"l1Reg":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"l2Reg":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"learnRate":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"maxTreeDepth":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"minSplitLoss":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"minTreeChildWeight":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"numClusters":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"numFactors":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"numParallelTree":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"optimizer":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"subsample":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"treeMethod":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"walsAlpha":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"}}},"bigquery_v2_HparamTuningTrial":{"description":"Training info of a trial in [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.","type":"object","properties":{"endTimeMs":{"description":"Ending time of the trial.","format":"int64","type":"string"},"errorMessage":{"description":"Error message for FAILED and INFEASIBLE trial.","type":"string"},"evalLoss":{"description":"Loss computed on the eval data at the end of trial.","format":"double","type":"number"},"evaluationMetrics":{"$ref":"#/components/schemas/bigquery_v2_EvaluationMetrics"},"hparamTuningEvaluationMetrics":{"$ref":"#/components/schemas/bigquery_v2_EvaluationMetrics"},"hparams":{"$ref":"#/components/schemas/bigquery_v2_TrainingOptions"},"startTimeMs":{"description":"Starting time of the trial.","format":"int64","type":"string"},"status":{"description":"The status of the trial.","enum":["TRIAL_STATUS_UNSPECIFIED","NOT_STARTED","RUNNING","SUCCEEDED","FAILED","INFEASIBLE","STOPPED_EARLY"],"type":"string"},"trainingLoss":{"description":"Loss computed on the training data at the end of trial.","format":"double","type":"number"},"trialId":{"description":"1-based index of the trial.","format":"int64","type":"string"}}},"bigquery_v2_IncrementalResultStats":{"description":"Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available.","type":"object","properties":{"disabledReason":{"description":"Output only. Reason why incremental query results are/were not written by the query.","readOnly":true,"enum":["DISABLED_REASON_UNSPECIFIED","OTHER","UNSUPPORTED_OPERATOR"],"type":"string"},"disabledReasonDetails":{"description":"Output only. Additional human-readable clarification, if available, for DisabledReason.","readOnly":true,"type":"string"},"firstIncrementalRowTime":{"description":"Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.","format":"google-datetime","readOnly":true,"type":"string"},"incrementalRowCount":{"description":"Output only. Number of rows that were in the latest result set before query completion.","format":"int64","readOnly":true,"type":"string"},"lastIncrementalRowTime":{"description":"Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.","format":"google-datetime","readOnly":true,"type":"string"},"resultSetLastModifyTime":{"description":"Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.","format":"google-datetime","readOnly":true,"type":"string"},"resultSetLastReplaceTime":{"description":"Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.","format":"google-datetime","readOnly":true,"type":"string"}}},"bigquery_v2_IndexPruningStats":{"description":"Statistics for index pruning.","type":"object","properties":{"baseTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"indexId":{"description":"The index id.","type":"string"},"postIndexPruningParallelInputCount":{"description":"The number of parallel inputs after index pruning.","format":"int64","type":"string"},"preIndexPruningParallelInputCount":{"description":"The number of parallel inputs before index pruning.","format":"int64","type":"string"}}},"bigquery_v2_IndexUnusedReason":{"description":"Reason about why no search index was used in the search query (or sub-query).","type":"object","properties":{"baseTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"code":{"description":"Specifies the high-level reason for the scenario when no search index was used.","enum":["CODE_UNSPECIFIED","INDEX_CONFIG_NOT_AVAILABLE","PENDING_INDEX_CREATION","BASE_TABLE_TRUNCATED","INDEX_CONFIG_MODIFIED","TIME_TRAVEL_QUERY","NO_PRUNING_POWER","UNINDEXED_SEARCH_FIELDS","UNSUPPORTED_SEARCH_PATTERN","OPTIMIZED_WITH_MATERIALIZED_VIEW","SECURED_BY_DATA_MASKING","MISMATCHED_TEXT_ANALYZER","BASE_TABLE_TOO_SMALL","BASE_TABLE_TOO_LARGE","ESTIMATED_PERFORMANCE_GAIN_TOO_LOW","COLUMN_METADATA_INDEX_NOT_USED","NOT_SUPPORTED_IN_STANDARD_EDITION","INDEX_SUPPRESSED_BY_FUNCTION_OPTION","QUERY_CACHE_HIT","STALE_INDEX","INTERNAL_ERROR","OTHER_REASON"],"type":"string"},"indexName":{"description":"Specifies the name of the unused search index, if available.","type":"string"},"message":{"description":"Free form human-readable reason for the scenario when no search index was used.","type":"string"}}},"bigquery_v2_InputDataChange":{"description":"Details about the input data change insight.","type":"object","properties":{"recordsReadDiffPercentage":{"description":"Output only. Records read difference percentage compared to a previous run.","format":"float","readOnly":true,"type":"number"}}},"bigquery_v2_IntArray":{"description":"An array of int.","type":"object","properties":{"elements":{"description":"Elements in the int array.","type":"array","items":{"format":"int64","type":"string"}}}},"bigquery_v2_IntArrayHparamSearchSpace":{"description":"Search space for int array.","type":"object","properties":{"candidates":{"description":"Candidates for the int array parameter.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IntArray"}}}},"bigquery_v2_IntCandidates":{"description":"Discrete candidates of an int hyperparameter.","type":"object","properties":{"candidates":{"description":"Candidates for the int parameter in increasing order.","type":"array","items":{"format":"int64","type":"string"}}}},"bigquery_v2_IntHparamSearchSpace":{"description":"Search space for an int hyperparameter.","type":"object","properties":{"candidates":{"$ref":"#/components/schemas/bigquery_v2_IntCandidates"},"range":{"$ref":"#/components/schemas/bigquery_v2_IntRange"}}},"bigquery_v2_IntRange":{"description":"Range of an int hyperparameter.","type":"object","properties":{"max":{"description":"Max value of the int parameter.","format":"int64","type":"string"},"min":{"description":"Min value of the int parameter.","format":"int64","type":"string"}}},"bigquery_v2_IterationResult":{"description":"Information about a single iteration of the training run.","type":"object","properties":{"arimaResult":{"$ref":"#/components/schemas/bigquery_v2_ArimaResult"},"clusterInfos":{"description":"Information about top clusters for clustering models.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ClusterInfo"}},"durationMs":{"description":"Time taken to run the iteration in milliseconds.","format":"int64","type":"string"},"evalLoss":{"description":"Loss computed on the eval data at the end of iteration.","format":"double","type":"number"},"index":{"description":"Index of the iteration, 0 based.","format":"int32","type":"integer"},"learnRate":{"description":"Learn rate used for this iteration.","format":"double","type":"number"},"principalComponentInfos":{"description":"The information of the principal components.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_PrincipalComponentInfo"}},"trainingLoss":{"description":"Loss computed on the training data at the end of iteration.","format":"double","type":"number"}}},"bigquery_v2_Job":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/bigquery_v2_JobConfiguration"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"id":{"description":"Output only. Opaque ID field of the job.","readOnly":true,"type":"string"},"jobCreationReason":{"$ref":"#/components/schemas/bigquery_v2_JobCreationReason"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"Output only. The type of the resource.","readOnly":true,"default":"bigquery#job","type":"string"},"principal_subject":{"description":"Output only. [Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities.","readOnly":true,"type":"string"},"selfLink":{"description":"Output only. A URL that can be used to access the resource again.","readOnly":true,"type":"string"},"statistics":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics"},"status":{"$ref":"#/components/schemas/bigquery_v2_JobStatus"},"user_email":{"description":"Output only. Email address of the user who ran the job.","readOnly":true,"type":"string"}}},"bigquery_v2_JobCancelResponse":{"description":"Describes format of a jobs cancellation response.","type":"object","properties":{"job":{"$ref":"#/components/schemas/bigquery_v2_Job"},"kind":{"description":"The resource type of the response.","default":"bigquery#jobCancelResponse","type":"string"}}},"bigquery_v2_JobConfiguration":{"type":"object","properties":{"copy":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationTableCopy"},"dryRun":{"description":"Optional. If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.","type":"boolean"},"extract":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationExtract"},"jobTimeoutMs":{"description":"Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.","format":"int64","type":"string"},"jobType":{"description":"Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.","type":"string"},"labels":{"description":"The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"load":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationLoad"},"maxSlots":{"description":"Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.","format":"int32","type":"integer"},"query":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationQuery"},"reservation":{"description":"Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`.","type":"string"}}},"bigquery_v2_JobConfigurationExtract":{"description":"JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.","type":"object","properties":{"compression":{"description":"Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models.","type":"string"},"destinationFormat":{"description":"Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.","type":"string"},"destinationUri":{"description":"[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.","type":"string"},"destinationUris":{"description":"[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.","type":"array","items":{"type":"string"}},"fieldDelimiter":{"description":"Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.","type":"string"},"modelExtractOptions":{"$ref":"#/components/schemas/bigquery_v2_ModelExtractOptions"},"nativeGeographyExportEnabled":{"description":"Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type.","type":"boolean"},"printHeader":{"description":"Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.","default":true,"type":"boolean"},"sourceModel":{"$ref":"#/components/schemas/bigquery_v2_ModelReference"},"sourceTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"useAvroLogicalTypes":{"description":"Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.","type":"boolean"}}},"bigquery_v2_JobConfigurationLoad":{"description":"JobConfigurationLoad contains the configuration properties for loading data into a destination table.","type":"object","properties":{"allowJaggedRows":{"description":"Optional. Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.","type":"boolean"},"allowQuotedNewlines":{"description":"Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.","type":"boolean"},"autodetect":{"description":"Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.","type":"boolean"},"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"columnNameCharacterMap":{"description":"Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error.","enum":["COLUMN_NAME_CHARACTER_MAP_UNSPECIFIED","STRICT","V1","V2"],"type":"string"},"connectionProperties":{"description":"Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConnectionProperty"}},"copyFilesOnly":{"description":"Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified.","type":"boolean"},"createDisposition":{"description":"Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"createSession":{"description":"Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic.","type":"boolean"},"dateFormat":{"description":"Optional. Date format used for parsing DATE values.","type":"string"},"datetimeFormat":{"description":"Optional. Date format used for parsing DATETIME values.","type":"string"},"decimalTargetTypes":{"description":"Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.","type":"array","items":{"enum":["DECIMAL_TARGET_TYPE_UNSPECIFIED","NUMERIC","BIGNUMERIC","STRING"],"type":"string"}},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"destinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"destinationTableProperties":{"$ref":"#/components/schemas/bigquery_v2_DestinationTableProperties"},"encoding":{"description":"Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the `quote` and `fieldDelimiter` properties. If you don't specify an encoding, or if you specify a UTF-8 encoding when the CSV file is not UTF-8 encoded, BigQuery attempts to convert the data to UTF-8. Generally, your data loads successfully, but it may not match byte-for-byte what you expect. To avoid this, specify the correct encoding by using the `--encoding` flag. If BigQuery can't convert a character other than the ASCII `0` character, BigQuery converts the character to the standard Unicode replacement character: �.","type":"string"},"fieldDelimiter":{"description":"Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence \"\\t\" (U+0009) to specify a tab separator. The default value is comma (\",\", U+002C).","type":"string"},"fileSetSpecType":{"description":"Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default, source URIs are expanded against the underlying storage. You can also specify manifest files to control how the file set is constructed. This option is only applicable to object storage systems.","enum":["FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH","FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST"],"type":"string"},"hivePartitioningOptions":{"$ref":"#/components/schemas/bigquery_v2_HivePartitioningOptions"},"ignoreUnknownValues":{"description":"Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.","type":"boolean"},"jsonExtension":{"description":"Optional. Load option to be used together with source_format newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and source_format must be set to NEWLINE_DELIMITED_JSON).","enum":["JSON_EXTENSION_UNSPECIFIED","GEOJSON"],"type":"string"},"maxBadRecords":{"description":"Optional. The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This is only supported for CSV and NEWLINE_DELIMITED_JSON file formats.","format":"int32","type":"integer"},"nullMarker":{"description":"Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.","type":"string"},"nullMarkers":{"description":"Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.","type":"array","items":{"type":"string"}},"parquetOptions":{"$ref":"#/components/schemas/bigquery_v2_ParquetOptions"},"preserveAsciiControlCharacters":{"description":"Optional. When sourceFormat is set to \"CSV\", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\\x00' to '\\x1F') are preserved.","type":"boolean"},"projectionFields":{"description":"If sourceFormat is set to \"DATASTORE_BACKUP\", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.","type":"array","items":{"type":"string"}},"quote":{"description":"Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' \" ', use ' \"\" '. @default \"","default":"\"","type":"string"},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"referenceFileSchemaUri":{"description":"Optional. The user can provide a reference file with the reader schema. This file is only loaded if it is part of source URIs, but is not loaded otherwise. It is enabled for the following formats: AVRO, PARQUET, ORC.","type":"string"},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"schemaInline":{"description":"[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\".","type":"string"},"schemaInlineFormat":{"description":"[Deprecated] The format of the schemaInline property.","type":"string"},"schemaUpdateOptions":{"description":"Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.","type":"array","items":{"type":"string"}},"skipLeadingRows":{"description":"Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.","format":"int32","type":"integer"},"sourceColumnMatch":{"description":"Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible.","enum":["SOURCE_COLUMN_MATCH_UNSPECIFIED","POSITION","NAME"],"type":"string"},"sourceFormat":{"description":"Optional. The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro, specify \"AVRO\". For parquet, specify \"PARQUET\". For orc, specify \"ORC\". The default value is CSV.","type":"string"},"sourceUris":{"description":"[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.","type":"array","items":{"type":"string"}},"timeFormat":{"description":"Optional. Date format used for parsing TIME values.","type":"string"},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"timeZone":{"description":"Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone.","type":"string"},"timestampFormat":{"description":"Optional. Date format used for parsing TIMESTAMP values.","type":"string"},"timestampTargetPrecision":{"description":"Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, AVRO, and Iceberg External Table. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.","type":"array","items":{"format":"int32","type":"integer"}},"useAvroLogicalTypes":{"description":"Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).","type":"boolean"},"writeDisposition":{"description":"Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"}}},"bigquery_v2_JobConfigurationQuery":{"description":"JobConfigurationQuery configures a BigQuery query job.","type":"object","properties":{"allowLargeResults":{"description":"Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.","default":false,"type":"boolean"},"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"connectionProperties":{"description":"Connection properties which can modify the query behavior.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConnectionProperty"}},"continuous":{"description":"[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.","type":"boolean"},"createDisposition":{"description":"Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"createSession":{"description":"If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic.","type":"boolean"},"defaultDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"destinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"flattenResults":{"description":"Optional. If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For GoogleSQL queries, this flag is ignored and results are never flattened.","default":true,"type":"boolean"},"maximumBillingTier":{"description":"Optional. [Deprecated] Maximum billing tier allowed for this query. The billing tier controls the amount of compute resources allotted to the query, and multiplies the on-demand cost of the query accordingly. A query that runs within its allotted resources will succeed and indicate its billing tier in statistics.query.billingTier, but if the query exceeds its allotted resources, it will fail with billingTierLimitExceeded. WARNING: The billed byte amount can be multiplied by an amount up to this number! Most users should not need to alter this setting, and we recommend that you avoid introducing new uses of it.","format":"int32","default":1,"type":"integer"},"maximumBytesBilled":{"description":"Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.","format":"int64","type":"string"},"parameterMode":{"description":"GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.","type":"string"},"preserveNulls":{"description":"[Deprecated] This property is deprecated.","type":"boolean"},"priority":{"description":"Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.","type":"string"},"query":{"description":"[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.","type":"string"},"queryParameters":{"description":"Query parameters for GoogleSQL queries.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameter"}},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"schemaUpdateOptions":{"description":"Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.","type":"array","items":{"type":"string"}},"scriptOptions":{"$ref":"#/components/schemas/bigquery_v2_ScriptOptions"},"secureContext":{"$ref":"#/components/schemas/bigquery_v2_SecureContext"},"systemVariables":{"$ref":"#/components/schemas/bigquery_v2_SystemVariables"},"tableDefinitions":{"description":"Optional. You can specify external table definitions, which operate as ephemeral tables that can be queried. These definitions are configured using a JSON map, where the string key represents the table identifier, and the value is the corresponding external data configuration object.","type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_ExternalDataConfiguration"}},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"useLegacySql":{"description":"Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.","default":true,"type":"boolean"},"useQueryCache":{"description":"Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.","default":true,"type":"boolean"},"userDefinedFunctionResources":{"description":"Describes user-defined function resources used in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_UserDefinedFunctionResource"}},"writeDisposition":{"description":"Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"writeIncrementalResults":{"description":"Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.","type":"boolean"}}},"bigquery_v2_JobConfigurationTableCopy":{"description":"JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see [Copy a table](https://cloud.google.com/bigquery/docs/managing-tables#copy-table).","type":"object","properties":{"createDisposition":{"description":"Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"destinationExpirationTime":{"description":"Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.","format":"google-datetime","type":"string"},"destinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"operationType":{"description":"Optional. Supported operation types in table copy job.","enum":["OPERATION_TYPE_UNSPECIFIED","COPY","SNAPSHOT","RESTORE","CLONE"],"type":"string"},"sourceTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"sourceTables":{"description":"[Pick one] Source tables to copy.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"writeDisposition":{"description":"Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema and table constraints from the source table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"}}},"bigquery_v2_JobCreationReason":{"description":"Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`.","type":"object","properties":{"code":{"description":"Output only. Specifies the high level reason why a Job was created.","readOnly":true,"enum":["CODE_UNSPECIFIED","REQUESTED","LONG_RUNNING","LARGE_RESULTS","OTHER"],"type":"string"}}},"bigquery_v2_JobList":{"description":"JobList is the response format for a jobs.list call.","type":"object","properties":{"etag":{"description":"A hash of this page of results.","type":"string"},"jobs":{"description":"List of jobs that were requested.","type":"array","items":{"description":"ListFormatJob is a partial projection of job information returned as part of a jobs.list response.","type":"object","properties":{"configuration":{"$ref":"#/components/schemas/bigquery_v2_JobConfiguration"},"errorResult":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"id":{"description":"Unique opaque ID of the job.","type":"string"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"The resource type.","type":"string"},"principal_subject":{"description":"[Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities.","type":"string"},"state":{"description":"Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.","type":"string"},"statistics":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics"},"status":{"$ref":"#/components/schemas/bigquery_v2_JobStatus"},"user_email":{"description":"[Full-projection-only] Email address of the user who ran the job.","type":"string"}}}},"kind":{"description":"The resource type of the response.","default":"bigquery#jobList","type":"string"},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"unreachable":{"description":"A list of skipped locations that were unreachable. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations. Example: \"europe-west5\"","type":"array","items":{"type":"string"}}}},"bigquery_v2_JobReference":{"description":"A job reference is a fully qualified identifier for referring to a job.","type":"object","properties":{"jobId":{"description":"Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.","type":"string"},"location":{"description":"Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations","type":"string"},"projectId":{"description":"Required. The ID of the project containing this job.","type":"string"}}},"bigquery_v2_JobStatistics":{"description":"Statistics for a single job execution.","type":"object","properties":{"completionRatio":{"description":"Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.","format":"double","readOnly":true,"type":"number"},"copy":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics5"},"creationTime":{"description":"Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.","format":"int64","readOnly":true,"type":"string"},"dataMaskingStatistics":{"$ref":"#/components/schemas/bigquery_v2_DataMaskingStatistics"},"edition":{"description":"Output only. Name of edition corresponding to the reservation for this job at the time of this update.","readOnly":true,"enum":["RESERVATION_EDITION_UNSPECIFIED","STANDARD","ENTERPRISE","ENTERPRISE_PLUS"],"type":"string"},"endTime":{"description":"Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.","format":"int64","readOnly":true,"type":"string"},"extract":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics4"},"finalExecutionDurationMs":{"description":"Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job.","format":"int64","readOnly":true,"type":"string"},"globalQueryRemoteRegions":{"description":"Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries).","readOnly":true,"type":"array","items":{"type":"string"}},"load":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics3"},"numChildJobs":{"description":"Output only. Number of child jobs executed.","format":"int64","readOnly":true,"type":"string"},"parentGlobalQueryJob":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"parentJobId":{"description":"Output only. If this is a child job, specifies the job ID of the parent.","readOnly":true,"type":"string"},"query":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics2"},"quotaDeferments":{"description":"Output only. Quotas which delayed this job's start time.","readOnly":true,"type":"array","items":{"type":"string"}},"reservationGroupPath":{"description":"Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group.","readOnly":true,"type":"array","items":{"type":"string"}},"reservationUsage":{"description":"Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.","readOnly":true,"type":"array","items":{"description":"Job resource usage breakdown by reservation.","type":"object","properties":{"name":{"description":"Reservation name or \"unreserved\" for on-demand resource usage and multi-statement queries.","type":"string"},"slotMs":{"description":"Total slot milliseconds used by the reservation for a particular job.","format":"int64","type":"string"}}}},"reservation_id":{"description":"Output only. Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.","readOnly":true,"type":"string"},"rowLevelSecurityStatistics":{"$ref":"#/components/schemas/bigquery_v2_RowLevelSecurityStatistics"},"scriptStatistics":{"$ref":"#/components/schemas/bigquery_v2_ScriptStatistics"},"sessionInfo":{"$ref":"#/components/schemas/bigquery_v2_SessionInfo"},"startTime":{"description":"Output only. Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessed":{"description":"Output only. Total bytes processed for the job.","format":"int64","readOnly":true,"type":"string"},"totalSlotMs":{"description":"Output only. Slot-milliseconds for the job.","format":"int64","readOnly":true,"type":"string"},"transactionInfo":{"$ref":"#/components/schemas/bigquery_v2_TransactionInfo"}}},"bigquery_v2_JobStatistics2":{"description":"Statistics for a query job.","type":"object","properties":{"biEngineStatistics":{"$ref":"#/components/schemas/bigquery_v2_BiEngineStatistics"},"billingTier":{"description":"Output only. Billing tier for the job. This is a BigQuery-specific concept which is not related to the Google Cloud notion of \"free tier\". The value here is a measure of the query's resource consumption relative to the amount of data scanned. For on-demand queries, the limit is 100, and all queries within this limit are billed at the standard on-demand rates. On-demand queries that exceed this limit will fail with a billingTierLimitExceeded error.","format":"int32","readOnly":true,"type":"integer"},"cacheHit":{"description":"Output only. Whether the query result was fetched from the query cache.","readOnly":true,"type":"boolean"},"dclTargetDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"dclTargetTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"dclTargetView":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"ddlAffectedRowAccessPolicyCount":{"description":"Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.","format":"int64","readOnly":true,"type":"string"},"ddlDestinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"ddlOperationPerformed":{"description":"Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.","readOnly":true,"type":"string"},"ddlTargetDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"ddlTargetRoutine":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"},"ddlTargetRowAccessPolicy":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicyReference"},"ddlTargetTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"dmlStats":{"$ref":"#/components/schemas/bigquery_v2_DmlStatistics"},"estimatedBytesProcessed":{"description":"Output only. The original estimate of bytes processed for the job.","format":"int64","readOnly":true,"type":"string"},"exportDataStatistics":{"$ref":"#/components/schemas/bigquery_v2_ExportDataStatistics"},"externalServiceCosts":{"description":"Output only. Job cost breakdown as bigquery internal cost and external service costs.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExternalServiceCost"}},"genAiStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiStats"},"incrementalResultStats":{"$ref":"#/components/schemas/bigquery_v2_IncrementalResultStats"},"loadQueryStatistics":{"$ref":"#/components/schemas/bigquery_v2_LoadQueryStatistics"},"materializedViewStatistics":{"$ref":"#/components/schemas/bigquery_v2_MaterializedViewStatistics"},"metadataCacheStatistics":{"$ref":"#/components/schemas/bigquery_v2_MetadataCacheStatistics"},"mlStatistics":{"$ref":"#/components/schemas/bigquery_v2_MlStatistics"},"modelTraining":{"$ref":"#/components/schemas/bigquery_v2_BigQueryModelTraining"},"modelTrainingCurrentIteration":{"description":"Deprecated.","format":"int32","type":"integer"},"modelTrainingExpectedTotalIteration":{"description":"Deprecated.","format":"int64","type":"string"},"numDmlAffectedRows":{"description":"Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.","format":"int64","readOnly":true,"type":"string"},"objectStorageStats":{"description":"Output only. Storage and caching statistics per cloud provider for queries over object storage.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ObjectStorageStats"}},"performanceInsights":{"$ref":"#/components/schemas/bigquery_v2_PerformanceInsights"},"queryInfo":{"$ref":"#/components/schemas/bigquery_v2_QueryInfo"},"queryPlan":{"description":"Output only. Describes execution plan for the query.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExplainQueryStage"}},"referencedLogicalViews":{"description":"Output only. Referenced logical views for the job.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"referencedPropertyGraphs":{"description":"Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_PropertyGraphReference"}},"referencedRoutines":{"description":"Output only. Referenced routines for the job.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"}},"referencedTables":{"description":"Output only. Referenced tables for the job.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"reservationUsage":{"description":"Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.","readOnly":true,"type":"array","items":{"description":"Job resource usage breakdown by reservation.","type":"object","properties":{"name":{"description":"Reservation name or \"unreserved\" for on-demand resource usage and multi-statement queries.","type":"string"},"slotMs":{"description":"Total slot milliseconds used by the reservation for a particular job.","format":"int64","type":"string"}}}},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"searchStatistics":{"$ref":"#/components/schemas/bigquery_v2_SearchStatistics"},"sparkStatistics":{"$ref":"#/components/schemas/bigquery_v2_SparkStatistics"},"statementType":{"description":"Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement.","readOnly":true,"type":"string"},"timeline":{"description":"Output only. Describes a timeline of job execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryTimelineSample"}},"totalBytesBilled":{"description":"Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessed":{"description":"Output only. Total bytes processed for the job.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessedAccuracy":{"description":"Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.","readOnly":true,"type":"string"},"totalPartitionsProcessed":{"description":"Output only. Total number of partitions processed from all partitioned tables referenced in the job.","format":"int64","readOnly":true,"type":"string"},"totalServicesSkuSlotMs":{"description":"Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `\"SERVICES_SKU\"`.","format":"int64","readOnly":true,"type":"string"},"totalSlotMs":{"description":"Output only. Slot-milliseconds for the job.","format":"int64","readOnly":true,"type":"string"},"transferredBytes":{"description":"Output only. Total bytes transferred for BigQuery Omni queries from the remote cloud back to Google Cloud. This tracks data movement over Google-managed connections (like query results). It doesn't include input data read from the external data lake (for example, S3) because that data stays within the remote cloud.","format":"int64","readOnly":true,"type":"string"},"undeclaredQueryParameters":{"description":"Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameter"}},"vectorSearchStatistics":{"$ref":"#/components/schemas/bigquery_v2_VectorSearchStatistics"}}},"bigquery_v2_JobStatistics3":{"description":"Statistics for a load job.","type":"object","properties":{"badRecords":{"description":"Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.","format":"int64","readOnly":true,"type":"string"},"inputFileBytes":{"description":"Output only. Number of bytes of source data in a load job.","format":"int64","readOnly":true,"type":"string"},"inputFiles":{"description":"Output only. Number of source files in a load job.","format":"int64","readOnly":true,"type":"string"},"outputBytes":{"description":"Output only. Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"},"outputRows":{"description":"Output only. Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"},"timeline":{"description":"Output only. Describes a timeline of job execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryTimelineSample"}}}},"bigquery_v2_JobStatistics4":{"description":"Statistics for an extract job.","type":"object","properties":{"destinationUriFileCounts":{"description":"Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.","readOnly":true,"type":"array","items":{"format":"int64","type":"string"}},"inputBytes":{"description":"Output only. Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes and doesn't have any relationship with the number of actual result bytes extracted in the desired format.","format":"int64","readOnly":true,"type":"string"},"timeline":{"description":"Output only. Describes a timeline of job execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryTimelineSample"}}}},"bigquery_v2_JobStatistics5":{"description":"Statistics for a copy job.","type":"object","properties":{"copiedLogicalBytes":{"description":"Output only. Number of logical bytes copied to the destination table.","format":"int64","readOnly":true,"type":"string"},"copiedRows":{"description":"Output only. Number of rows copied to the destination table.","format":"int64","readOnly":true,"type":"string"},"remoteDestinationRegion":{"description":"Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs.","readOnly":true,"type":"string"}}},"bigquery_v2_JobStatus":{"type":"object","properties":{"errorResult":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"errors":{"description":"Output only. The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has not completed or was unsuccessful.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"state":{"description":"Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.","readOnly":true,"type":"string"}}},"bigquery_v2_JoinRestrictionPolicy":{"description":"Represents privacy policy associated with \"join restrictions\". Join restriction gives data providers the ability to enforce joins on the 'join_allowed_columns' when data is queried from a privacy protected view.","type":"object","properties":{"joinAllowedColumns":{"description":"Optional. The only columns that joins are allowed on. This field is must be specified for join_conditions JOIN_ANY and JOIN_ALL and it cannot be set for JOIN_BLOCKED.","type":"array","items":{"type":"string"}},"joinCondition":{"description":"Optional. Specifies if a join is required or not on queries for the view. Default is JOIN_CONDITION_UNSPECIFIED.","enum":["JOIN_CONDITION_UNSPECIFIED","JOIN_ANY","JOIN_ALL","JOIN_NOT_REQUIRED","JOIN_BLOCKED"],"type":"string"}}},"bigquery_v2_JsonObject":{"description":"Represents a single JSON object.","type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_JsonValue"}},"bigquery_v2_JsonOptions":{"description":"Json Options for load and make external tables.","type":"object","properties":{"encoding":{"description":"Optional. The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.","type":"string"}}},"bigquery_v2_JsonValue":{},"bigquery_v2_LinkedDatasetMetadata":{"description":"Metadata about the Linked Dataset.","type":"object","properties":{"linkState":{"description":"Output only. Specifies whether Linked Dataset is currently in a linked state or not.","readOnly":true,"enum":["LINK_STATE_UNSPECIFIED","LINKED","UNLINKED"],"type":"string"}}},"bigquery_v2_LinkedDatasetSource":{"description":"A dataset source type which refers to another BigQuery dataset.","type":"object","properties":{"sourceDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"}}},"bigquery_v2_ListModelsResponse":{"description":"Response format for a single page when listing BigQuery ML models.","type":"object","properties":{"models":{"description":"Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Model"}},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"}}},"bigquery_v2_ListRoutinesResponse":{"description":"Describes the format of a single result page when listing routines.","type":"object","properties":{"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"routines":{"description":"Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, language, and remote_function_options.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}},"bigquery_v2_ListRowAccessPoliciesResponse":{"description":"Response message for the ListRowAccessPolicies method.","type":"object","properties":{"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"rowAccessPolicies":{"description":"Row access policies on the requested table.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}},"bigquery_v2_LoadQueryStatistics":{"description":"Statistics for a LOAD query.","type":"object","properties":{"badRecords":{"description":"Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.","format":"int64","readOnly":true,"type":"string"},"bytesTransferred":{"description":"Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing.","format":"int64","readOnly":true,"type":"string"},"inputFileBytes":{"description":"Output only. Number of bytes of source data in a LOAD query.","format":"int64","readOnly":true,"type":"string"},"inputFiles":{"description":"Output only. Number of source files in a LOAD query.","format":"int64","readOnly":true,"type":"string"},"outputBytes":{"description":"Output only. Size of the loaded data in bytes. Note that while a LOAD query is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"},"outputRows":{"description":"Output only. Number of rows imported in a LOAD query. Note that while a LOAD query is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_LocationMetadata":{"description":"BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.","type":"object","properties":{"legacyLocationId":{"description":"The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations.","type":"string"}}},"bigquery_v2_MaterializedView":{"description":"A materialized view considered for a query job.","type":"object","properties":{"chosen":{"description":"Whether the materialized view is chosen for the query. A materialized view can be chosen to rewrite multiple parts of the same query. If a materialized view is chosen to rewrite any part of the query, then this field is true, even if the materialized view was not chosen to rewrite others parts.","type":"boolean"},"estimatedBytesSaved":{"description":"If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.","format":"int64","type":"string"},"rejectedReason":{"description":"If present, specifies the reason why the materialized view was not chosen for the query.","enum":["REJECTED_REASON_UNSPECIFIED","NO_DATA","COST","BASE_TABLE_TRUNCATED","BASE_TABLE_DATA_CHANGE","BASE_TABLE_PARTITION_EXPIRATION_CHANGE","BASE_TABLE_EXPIRED_PARTITION","BASE_TABLE_INCOMPATIBLE_METADATA_CHANGE","TIME_ZONE","OUT_OF_TIME_TRAVEL_WINDOW","BASE_TABLE_FINE_GRAINED_SECURITY_POLICY","BASE_TABLE_TOO_STALE"],"type":"string"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_MaterializedViewDefinition":{"description":"Definition and configuration of a materialized view.","type":"object","properties":{"allowNonIncrementalDefinition":{"description":"Optional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. Non-incremental materialized views support an expanded range of SQL queries. The `allow_non_incremental_definition` option can't be changed after the materialized view is created.","type":"boolean"},"enableRefresh":{"description":"Optional. Enable automatic refresh of the materialized view when the base table is updated. The default value is \"true\".","type":"boolean"},"lastRefreshTime":{"description":"Output only. The time when this materialized view was last refreshed, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"maxStaleness":{"description":"[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).","format":"byte","type":"string"},"query":{"description":"Required. A query whose results are persisted.","type":"string"},"refreshIntervalMs":{"description":"Optional. The maximum frequency at which this materialized view will be refreshed. The default value is \"1800000\" (30 minutes).","format":"int64","type":"string"}}},"bigquery_v2_MaterializedViewStatistics":{"description":"Statistics of materialized views considered in a query job.","type":"object","properties":{"materializedView":{"description":"Materialized views considered for the query job. Only certain materialized views are used. For a detailed list, see the child message. If many materialized views are considered, then the list might be incomplete.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_MaterializedView"}}}},"bigquery_v2_MaterializedViewStatus":{"description":"Status of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message.","type":"object","properties":{"lastRefreshStatus":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"refreshWatermark":{"description":"Output only. Refresh watermark of materialized view. The base tables' data were collected into the materialized view cache until this time.","format":"google-datetime","readOnly":true,"type":"string"}}},"bigquery_v2_MetadataCacheStalenessInsight":{"description":"Column Metadata Index staleness detailed infnormation.","type":"object","properties":{"avgPreviousStalenessMs":{"description":"Output only. Average column metadata index staleness of previous runs with the same query hash.","format":"google-duration","readOnly":true,"type":"string"},"stalenessPercentageIncrease":{"description":"Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash.","format":"double","readOnly":true,"type":"number"}}},"bigquery_v2_MetadataCacheStatistics":{"description":"Statistics for metadata caching in queried tables.","type":"object","properties":{"tableMetadataCacheUsage":{"description":"Set for the Metadata caching eligible tables referenced in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableMetadataCacheUsage"}}}},"bigquery_v2_MlStatistics":{"description":"Job statistics specific to a BigQuery ML training job.","type":"object","properties":{"hparamTrials":{"description":"Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_HparamTuningTrial"}},"iterationResults":{"description":"Results for all completed iterations. Empty for [hyperparameter tuning jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IterationResult"}},"maxIterations":{"description":"Output only. Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.","format":"int64","readOnly":true,"type":"string"},"modelType":{"description":"Output only. The type of the model that is being trained.","readOnly":true,"enum":["MODEL_TYPE_UNSPECIFIED","LINEAR_REGRESSION","LOGISTIC_REGRESSION","KMEANS","MATRIX_FACTORIZATION","DNN_CLASSIFIER","TENSORFLOW","DNN_REGRESSOR","XGBOOST","BOOSTED_TREE_REGRESSOR","BOOSTED_TREE_CLASSIFIER","ARIMA","AUTOML_REGRESSOR","AUTOML_CLASSIFIER","PCA","DNN_LINEAR_COMBINED_CLASSIFIER","DNN_LINEAR_COMBINED_REGRESSOR","AUTOENCODER","ARIMA_PLUS","ARIMA_PLUS_XREG","RANDOM_FOREST_REGRESSOR","RANDOM_FOREST_CLASSIFIER","TENSORFLOW_LITE","ONNX","TRANSFORM_ONLY","CONTRIBUTION_ANALYSIS"],"type":"string"},"trainingType":{"description":"Output only. Training type of the job.","readOnly":true,"enum":["TRAINING_TYPE_UNSPECIFIED","SINGLE_TRAINING","HPARAM_TUNING"],"type":"string"}}},"bigquery_v2_Model":{"type":"object","properties":{"bestTrialId":{"description":"The best trial_id across all training runs.","format":"int64","type":"string"},"creationTime":{"description":"Output only. The time when this model was created, in millisecs since the epoch.","format":"int64","readOnly":true,"type":"string"},"defaultTrialId":{"description":"Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials.","format":"int64","readOnly":true,"type":"string"},"description":{"description":"Optional. A user-friendly description of this model.","type":"string"},"encryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"expirationTime":{"description":"Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.","format":"int64","type":"string"},"featureColumns":{"description":"Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}},"friendlyName":{"description":"Optional. A descriptive name for this model.","type":"string"},"hparamSearchSpaces":{"$ref":"#/components/schemas/bigquery_v2_HparamSearchSpaces"},"hparamTrials":{"description":"Output only. Trials of a [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_HparamTuningTrial"}},"labelColumns":{"description":"Output only. Label columns that were used to train this model. The output of the model will have a \"predicted_\" prefix to these columns.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}},"labels":{"description":"The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The time when this model was last modified, in millisecs since the epoch.","format":"int64","readOnly":true,"type":"string"},"location":{"description":"Output only. The geographic location where the model resides. This value is inherited from the dataset.","readOnly":true,"type":"string"},"modelReference":{"$ref":"#/components/schemas/bigquery_v2_ModelReference"},"modelType":{"description":"Output only. Type of the model resource.","readOnly":true,"enum":["MODEL_TYPE_UNSPECIFIED","LINEAR_REGRESSION","LOGISTIC_REGRESSION","KMEANS","MATRIX_FACTORIZATION","DNN_CLASSIFIER","TENSORFLOW","DNN_REGRESSOR","XGBOOST","BOOSTED_TREE_REGRESSOR","BOOSTED_TREE_CLASSIFIER","ARIMA","AUTOML_REGRESSOR","AUTOML_CLASSIFIER","PCA","DNN_LINEAR_COMBINED_CLASSIFIER","DNN_LINEAR_COMBINED_REGRESSOR","AUTOENCODER","ARIMA_PLUS","ARIMA_PLUS_XREG","RANDOM_FOREST_REGRESSOR","RANDOM_FOREST_CLASSIFIER","TENSORFLOW_LITE","ONNX","TRANSFORM_ONLY","CONTRIBUTION_ANALYSIS"],"type":"string"},"optimalTrialIds":{"description":"Output only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id.","readOnly":true,"type":"array","items":{"format":"int64","type":"string"}},"remoteModelInfo":{"$ref":"#/components/schemas/bigquery_v2_RemoteModelInfo"},"trainingRuns":{"description":"Information for all training runs in increasing order of start_time.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TrainingRun"}},"transformColumns":{"description":"Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TransformColumn"}}}},"bigquery_v2_ModelDefinition":{"type":"object","properties":{"modelOptions":{"description":"Deprecated.","type":"object","properties":{"labels":{"type":"array","items":{"type":"string"}},"lossType":{"type":"string"},"modelType":{"type":"string"}}},"trainingRuns":{"description":"Deprecated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BqmlTrainingRun"}}}},"bigquery_v2_ModelExtractOptions":{"description":"Options related to model extraction.","type":"object","properties":{"trialId":{"description":"The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.","format":"int64","type":"string"}}},"bigquery_v2_ModelReference":{"description":"Id path of a model.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this model.","type":"string"},"modelId":{"description":"Required. The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this model.","type":"string"}}},"bigquery_v2_MultiClassClassificationMetrics":{"description":"Evaluation metrics for multi-class classification/classifier models.","type":"object","properties":{"aggregateClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_AggregateClassificationMetrics"},"confusionMatrixList":{"description":"Confusion matrix at different thresholds.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConfusionMatrix"}}}},"bigquery_v2_ObjectStorageStats":{"description":"Storage and caching statistics for object storage.","type":"object","properties":{"cacheBytesRead":{"description":"Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read.","format":"int64","type":"string"},"cloudProvider":{"description":"The cloud provider for this block of statistics.","enum":["CLOUD_PROVIDER_UNSPECIFIED","GCP","AWS","AZURE"],"type":"string"},"objectStorageBytesRead":{"description":"Total bytes read directly from the cloud provider's storage.","format":"int64","type":"string"}}},"bigquery_v2_ParquetOptions":{"description":"Parquet Options for load and make external tables.","type":"object","properties":{"enableListInference":{"description":"Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.","type":"boolean"},"enumAsString":{"description":"Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.","type":"boolean"},"mapTargetType":{"description":"Optional. Indicates how to represent a Parquet map if present.","enum":["MAP_TARGET_TYPE_UNSPECIFIED","ARRAY_OF_STRUCT"],"type":"string"}}},"bigquery_v2_PartitionSkew":{"description":"Partition skew detailed information.","type":"object","properties":{"skewSources":{"description":"Output only. Source stages which produce skewed data.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_SkewSource"}}}},"bigquery_v2_PartitionedColumn":{"description":"The partitioning column information.","type":"object","properties":{"field":{"description":"Required. The name of the partition column.","type":"string"}}},"bigquery_v2_PartitioningDefinition":{"description":"The partitioning information, which includes managed table, external table and metastore partitioned table partition information.","type":"object","properties":{"partitionedColumn":{"description":"Optional. Details about each partitioning column. This field is output only for all partitioning types other than metastore partitioned tables. BigQuery native tables only support 1 partitioning column. Other table types may support 0, 1 or more partitioning columns. For metastore partitioned tables, the order must match the definition order in the Hive Metastore, where it must match the physical layout of the table. For example, CREATE TABLE a_table(id BIGINT, name STRING) PARTITIONED BY (city STRING, state STRING). In this case the values must be ['city', 'state'] in that order.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_PartitionedColumn"}}}},"bigquery_v2_PerformanceInsights":{"description":"Performance insights for the job.","type":"object","properties":{"avgPreviousExecutionMs":{"description":"Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash.","format":"int64","readOnly":true,"type":"string"},"stagePerformanceChangeInsights":{"description":"Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StagePerformanceChangeInsight"}},"stagePerformanceStandaloneInsights":{"description":"Output only. Standalone query stage performance insights, for exploring potential improvements.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StagePerformanceStandaloneInsight"}},"tableChangeInsights":{"description":"Output only. Performance insights for table-level attributes that changed compared to previous runs.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableChangeInsight"}}}},"bigquery_v2_Policy":{"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).","type":"object","properties":{"auditConfigs":{"description":"Specifies cloud audit logging configuration for this policy.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_AuditConfig"}},"bindings":{"description":"Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Binding"}},"etag":{"description":"`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.","format":"byte","type":"string"},"version":{"description":"Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"bigquery_v2_PrincipalComponentInfo":{"description":"Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.","type":"object","properties":{"cumulativeExplainedVarianceRatio":{"description":"The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.","format":"double","type":"number"},"explainedVariance":{"description":"Explained variance by this principal component, which is simply the eigenvalue.","format":"double","type":"number"},"explainedVarianceRatio":{"description":"Explained_variance over the total explained variance.","format":"double","type":"number"},"principalComponentId":{"description":"Id of the principal component.","format":"int64","type":"string"}}},"bigquery_v2_PrivacyPolicy":{"description":"Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views.","type":"object","properties":{"aggregationThresholdPolicy":{"$ref":"#/components/schemas/bigquery_v2_AggregationThresholdPolicy"},"differentialPrivacyPolicy":{"$ref":"#/components/schemas/bigquery_v2_DifferentialPrivacyPolicy"},"joinRestrictionPolicy":{"$ref":"#/components/schemas/bigquery_v2_JoinRestrictionPolicy"}}},"bigquery_v2_ProjectList":{"description":"Response object of ListProjects","type":"object","properties":{"etag":{"description":"A hash of the page of results.","type":"string"},"kind":{"description":"The resource type of the response.","default":"bigquery#projectList","type":"string"},"nextPageToken":{"description":"Use this token to request the next page of results.","type":"string"},"projects":{"description":"Projects to which the user has at least READ access. This field can be omitted if `totalItems` is 0.","type":"array","items":{"description":"Information about a single project.","type":"object","properties":{"friendlyName":{"description":"A descriptive name for this project. A wrapper is used here because friendlyName can be set to the empty string.","type":"string"},"id":{"description":"An opaque ID of this project.","type":"string"},"kind":{"description":"The resource type.","type":"string"},"numericId":{"description":"The numeric ID of this project.","format":"uint64","type":"string"},"projectReference":{"$ref":"#/components/schemas/bigquery_v2_ProjectReference"}}}},"totalItems":{"description":"The total number of projects in the page. A wrapper is used here because the field should still be in the response when the value is 0.","format":"int32","type":"integer"}}},"bigquery_v2_ProjectReference":{"description":"A unique reference to a project.","type":"object","properties":{"projectId":{"description":"Required. ID of the project. Can be either the numeric ID or the assigned ID of the project.","type":"string"}}},"bigquery_v2_PropertyGraphReference":{"description":"Id path of a property graph.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this property graph.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this property graph.","type":"string"},"propertyGraphId":{"description":"Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.","type":"string"}}},"bigquery_v2_PruningStats":{"description":"The column metadata index pruning statistics.","type":"object","properties":{"postCmetaPruningParallelInputCount":{"description":"The number of parallel inputs matched.","format":"int64","type":"string"},"postCmetaPruningPartitionCount":{"description":"The number of partitions matched.","format":"int64","type":"string"},"preCmetaPruningParallelInputCount":{"description":"The number of parallel inputs scanned.","format":"int64","type":"string"}}},"bigquery_v2_PythonOptions":{"description":"Options for a user-defined Python function.","type":"object","properties":{"entryPoint":{"description":"Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked.","type":"string"},"packages":{"description":"Optional. A list of Python package names along with versions to be installed. Example: [\"pandas>=2.1\", \"google-cloud-translate==3.11\"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages).","type":"array","items":{"type":"string"}}}},"bigquery_v2_QueryInfo":{"description":"Query optimization information for a QUERY job.","type":"object","properties":{"optimizationDetails":{"description":"Output only. Information about query optimizations.","readOnly":true,"type":"object","additionalProperties":{"description":"Properties of the object."}}}},"bigquery_v2_QueryParameter":{"description":"A parameter given to a query.","type":"object","properties":{"name":{"description":"Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.","type":"string"},"parameterType":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"},"parameterValue":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}}},"bigquery_v2_QueryParameterType":{"description":"The type of a query parameter.","type":"object","properties":{"arrayType":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"},"rangeElementType":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"},"structTypes":{"description":"Optional. The types of the fields of this struct, in order, if this is a struct.","type":"array","items":{"description":"The type of a struct parameter.","type":"object","properties":{"description":{"description":"Optional. Human-oriented description of the field.","type":"string"},"name":{"description":"Optional. The name of this field.","type":"string"},"type":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"}}}},"timestampPrecision":{"description":"Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)","format":"int64","default":"6","type":"string"},"type":{"description":"Required. The top level type of this field.","type":"string"}}},"bigquery_v2_QueryParameterValue":{"description":"The value of a query parameter.","type":"object","properties":{"arrayValues":{"description":"Optional. The array values, if this is an array type.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}},"rangeValue":{"$ref":"#/components/schemas/bigquery_v2_RangeValue"},"structValues":{"description":"The struct field values.","type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}},"value":{"description":"Optional. The value of this value, if a simple scalar type.","type":"string"}}},"bigquery_v2_QueryRequest":{"description":"Describes the format of the jobs.query request.","type":"object","properties":{"arrowSerializationOptions":{"$ref":"#/components/schemas/bigquery_v2_ArrowSerializationOptions"},"connectionProperties":{"description":"Optional. Connection properties which can modify the query behavior.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConnectionProperty"}},"continuous":{"description":"[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.","type":"boolean"},"createSession":{"description":"Optional. If true, creates a new session using a randomly generated session_id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. The session location will be set to QueryRequest.location if it is present, otherwise it's set to the default location based on existing routing logic.","type":"boolean"},"defaultDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"dryRun":{"description":"Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.","type":"boolean"},"formatOptions":{"$ref":"#/components/schemas/bigquery_v2_DataFormatOptions"},"jobCreationMode":{"description":"Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode.","enum":["JOB_CREATION_MODE_UNSPECIFIED","JOB_CREATION_REQUIRED","JOB_CREATION_OPTIONAL"],"type":"string"},"jobTimeoutMs":{"description":"Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. This timeout applies to the query even if a job does not need to be created.","format":"int64","type":"string"},"kind":{"description":"The resource type of the request.","default":"bigquery#queryRequest","type":"string"},"labels":{"description":"Optional. The labels associated with this query. Labels can be used to organize and group query jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"location":{"description":"The geographic location where the job should run. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"maxResults":{"description":"Optional. The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.","format":"uint32","type":"integer"},"maxSlots":{"description":"Optional. A target limit on the rate of slot consumption by this query. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this query to keep it below the configured limit, even if the query is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.","format":"int32","type":"integer"},"maximumBytesBilled":{"description":"Optional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used.","format":"int64","type":"string"},"parameterMode":{"description":"GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.","type":"string"},"preserveNulls":{"description":"This property is deprecated.","type":"boolean"},"query":{"description":"Required. A query string to execute, using Google Standard SQL or legacy SQL syntax. Example: \"SELECT COUNT(f1) FROM myProjectId.myDatasetId.myTableId\".","type":"string"},"queryParameters":{"description":"Query parameters for GoogleSQL queries.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameter"}},"queryResultsFormat":{"description":"Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available.","enum":["QUERY_RESULTS_FORMAT_UNSPECIFIED","STRUCT_ENCODING","ARROW"],"type":"string"},"requestId":{"description":"Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.","type":"string"},"reservation":{"description":"Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`. This requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`.","type":"string"},"secureContext":{"$ref":"#/components/schemas/bigquery_v2_SecureContext"},"timeoutMs":{"description":"Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.","format":"uint32","type":"integer"},"useLegacySql":{"description":"Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.","default":true,"type":"boolean"},"useQueryCache":{"description":"Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.","default":true,"type":"boolean"},"writeIncrementalResults":{"description":"Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.","type":"boolean"}}},"bigquery_v2_QueryResponse":{"type":"object","properties":{"arrowRecordBatch":{"$ref":"#/components/schemas/bigquery_v2_ArrowRecordBatch"},"arrowSchema":{"$ref":"#/components/schemas/bigquery_v2_ArrowSchema"},"cacheHit":{"description":"Whether the query result was fetched from the query cache.","type":"boolean"},"creationTime":{"description":"Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries.","format":"int64","readOnly":true,"type":"string"},"dmlStats":{"$ref":"#/components/schemas/bigquery_v2_DmlStatistics"},"endTime":{"description":"Output only. End time of this query, in milliseconds since the epoch. This field will be present whenever a query job is in the DONE state.","format":"int64","readOnly":true,"type":"string"},"errors":{"description":"Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"jobComplete":{"description":"Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.","type":"boolean"},"jobCreationReason":{"$ref":"#/components/schemas/bigquery_v2_JobCreationReason"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"The resource type.","default":"bigquery#queryResponse","type":"string"},"location":{"description":"Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations","readOnly":true,"type":"string"},"numDmlAffectedRows":{"description":"Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.","format":"int64","readOnly":true,"type":"string"},"pageRowCount":{"description":"Output only. The number of rows out of `total_rows` returned in this response. This feature is not yet available.","format":"int64","readOnly":true,"type":"string"},"pageToken":{"description":"A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results).","type":"string"},"queryId":{"description":"Auto-generated ID for the query.","type":"string"},"rows":{"description":"An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableRow"}},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"sessionInfo":{"$ref":"#/components/schemas/bigquery_v2_SessionInfo"},"startTime":{"description":"Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE.","format":"int64","readOnly":true,"type":"string"},"statementType":{"description":"Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement.","readOnly":true,"type":"string"},"totalBytesBilled":{"description":"Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessed":{"description":"The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.","format":"int64","type":"string"},"totalRows":{"description":"The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.","format":"uint64","type":"string"},"totalSlotMs":{"description":"Output only. Number of slot ms the user is actually billed for.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_QueryTimelineSample":{"description":"Summary of the state of query execution at a given time.","type":"object","properties":{"activeUnits":{"description":"Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.","format":"int64","type":"string"},"completedUnits":{"description":"Total parallel units of work completed by this query.","format":"int64","type":"string"},"elapsedMs":{"description":"Milliseconds elapsed since the start of query execution.","format":"int64","type":"string"},"estimatedRunnableUnits":{"description":"Units of work that can be scheduled immediately. Providing additional slots for these units of work will accelerate the query, if no other query in the reservation needs additional slots.","format":"int64","type":"string"},"pendingUnits":{"description":"Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.","format":"int64","type":"string"},"shuffleRamUsageRatio":{"description":"Total shuffle usage ratio in shuffle RAM per reservation of this query. This will be provided for reservation customers only.","format":"double","type":"number"},"totalSlotMs":{"description":"Cumulative slot-ms consumed by the query.","format":"int64","type":"string"}}},"bigquery_v2_RangePartitioning":{"type":"object","properties":{"field":{"description":"Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED.","type":"string"},"range":{"description":"[Experimental] Defines the ranges for range partitioning.","type":"object","properties":{"end":{"description":"[Experimental] The end of range partitioning, exclusive.","format":"int64","type":"string"},"interval":{"description":"[Experimental] The width of each interval.","format":"int64","type":"string"},"start":{"description":"[Experimental] The start of range partitioning, inclusive.","format":"int64","type":"string"}}}}},"bigquery_v2_RangeValue":{"description":"Represents the value of a range.","type":"object","properties":{"end":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"},"start":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}}},"bigquery_v2_RankingMetrics":{"description":"Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit.","type":"object","properties":{"averageRank":{"description":"Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.","format":"double","type":"number"},"meanAveragePrecision":{"description":"Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.","format":"double","type":"number"},"meanSquaredError":{"description":"Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.","format":"double","type":"number"},"normalizedDiscountedCumulativeGain":{"description":"A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.","format":"double","type":"number"}}},"bigquery_v2_RegressionMetrics":{"description":"Evaluation metrics for regression and explicit feedback type matrix factorization models.","type":"object","properties":{"meanAbsoluteError":{"description":"Mean absolute error.","format":"double","type":"number"},"meanSquaredError":{"description":"Mean squared error.","format":"double","type":"number"},"meanSquaredLogError":{"description":"Mean squared log error.","format":"double","type":"number"},"medianAbsoluteError":{"description":"Median absolute error.","format":"double","type":"number"},"rSquared":{"description":"R^2 score. This corresponds to r2_score in ML.EVALUATE.","format":"double","type":"number"}}},"bigquery_v2_RemoteFunctionOptions":{"description":"Options for a remote user-defined function.","type":"object","properties":{"connection":{"description":"Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: ```\"projects/{projectId}/locations/{locationId}/connections/{connectionId}\"```","type":"string"},"endpoint":{"description":"Endpoint of the user-provided remote service, e.g. ```https://us-east1-my_gcf_project.cloudfunctions.net/remote_add```","type":"string"},"maxBatchingRows":{"description":"Max number of rows in each batch sent to the remote service. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.","format":"int64","type":"string"},"userDefinedContext":{"description":"User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service. The total number of bytes of keys and values must be less than 8KB.","type":"object","additionalProperties":{"type":"string"}}}},"bigquery_v2_RemoteModelInfo":{"description":"Remote Model Info","type":"object","properties":{"connection":{"description":"Output only. Fully qualified name of the user-provided connection object of the remote model. Format: ```\"projects/{project_id}/locations/{location_id}/connections/{connection_id}\"```","readOnly":true,"type":"string"},"endpoint":{"description":"Output only. The endpoint for remote model.","readOnly":true,"type":"string"},"maxBatchingRows":{"description":"Output only. Max number of rows in each batch sent to the remote service. If unset, the number of rows in each batch is set dynamically.","format":"int64","readOnly":true,"type":"string"},"remoteModelVersion":{"description":"Output only. The model version for LLM.","readOnly":true,"type":"string"},"remoteServiceType":{"description":"Output only. The remote service type for remote model.","readOnly":true,"enum":["REMOTE_SERVICE_TYPE_UNSPECIFIED","CLOUD_AI_TRANSLATE_V3","CLOUD_AI_VISION_V1","CLOUD_AI_NATURAL_LANGUAGE_V1","CLOUD_AI_SPEECH_TO_TEXT_V2"],"type":"string"},"speechRecognizer":{"description":"Output only. The name of the speech recognizer to use for speech recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. Customers can specify this field at model creation. If not specified, a default recognizer `projects/{model project}/locations/global/recognizers/_` will be used. See more details at [recognizers](https://cloud.google.com/speech-to-text/v2/docs/reference/rest/v2/projects.locations.recognizers)","readOnly":true,"type":"string"}}},"bigquery_v2_RestrictionConfig":{"type":"object","properties":{"type":{"description":"Output only. Specifies the type of dataset/table restriction.","readOnly":true,"enum":["RESTRICTION_TYPE_UNSPECIFIED","RESTRICTED_DATA_EGRESS"],"type":"string"}}},"bigquery_v2_Routine":{"description":"A user-defined function or a stored procedure.","type":"object","properties":{"arguments":{"description":"Optional.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Argument"}},"buildStatus":{"$ref":"#/components/schemas/bigquery_v2_RoutineBuildStatus"},"creationTime":{"description":"Output only. The time when this routine was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"dataGovernanceType":{"description":"Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask).","enum":["DATA_GOVERNANCE_TYPE_UNSPECIFIED","DATA_MASKING"],"type":"string"},"definitionBody":{"description":"Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = \"SQL\"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, \"\\n\", y))` The definition_body is `concat(x, \"\\n\", y)` (\\n is not replaced with linebreak). If `language=\"JAVASCRIPT\"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return \"\\n\";\\n'` The definition_body is `return \"\\n\";\\n` Note that both \\n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID.","type":"string"},"description":{"description":"Optional. The description of the routine, if defined.","type":"string"},"determinismLevel":{"description":"Optional. The determinism level of the JavaScript UDF, if defined.","enum":["DETERMINISM_LEVEL_UNSPECIFIED","DETERMINISTIC","NOT_DETERMINISTIC"],"type":"string"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"externalRuntimeOptions":{"$ref":"#/components/schemas/bigquery_v2_ExternalRuntimeOptions"},"importedLibraries":{"description":"Optional. If language = \"JAVASCRIPT\", this field stores the path of the imported JAVASCRIPT libraries.","type":"array","items":{"type":"string"}},"language":{"description":"Optional. Defaults to \"SQL\" if remote_function_options field is absent, not set otherwise.","enum":["LANGUAGE_UNSPECIFIED","SQL","JAVASCRIPT","PYTHON","JAVA","SCALA"],"type":"string"},"lastModifiedTime":{"description":"Output only. The time when this routine was last modified, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"pythonOptions":{"$ref":"#/components/schemas/bigquery_v2_PythonOptions"},"remoteFunctionOptions":{"$ref":"#/components/schemas/bigquery_v2_RemoteFunctionOptions"},"returnTableType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlTableType"},"returnType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"routineReference":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"},"routineType":{"description":"Required. The type of routine.","enum":["ROUTINE_TYPE_UNSPECIFIED","SCALAR_FUNCTION","PROCEDURE","TABLE_VALUED_FUNCTION","AGGREGATE_FUNCTION"],"type":"string"},"securityMode":{"description":"Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.","enum":["SECURITY_MODE_UNSPECIFIED","DEFINER","INVOKER"],"type":"string"},"sparkOptions":{"$ref":"#/components/schemas/bigquery_v2_SparkOptions"},"strictMode":{"description":"Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If `strictMode` is set to `TRUE`, the procedure body is further checked for errors such as non-existent tables or columns. The `CREATE PROCEDURE` statement fails if the body fails any of these checks. If `strictMode` is set to `FALSE`, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify `strictMode=FALSE` to avoid non-existent procedure errors during validation. Default value is `TRUE`.","type":"boolean"}}},"bigquery_v2_RoutineBuildStatus":{"description":"The status of a routine build.","type":"object","properties":{"buildDuration":{"description":"Output only. The time taken for the image build. Populated only after the build succeeds or fails.","format":"google-duration","readOnly":true,"type":"string"},"buildState":{"description":"Output only. The current build state of the routine.","readOnly":true,"enum":["BUILD_STATE_UNSPECIFIED","IN_PROGRESS","SUCCEEDED","FAILED"],"type":"string"},"buildStateUpdateTime":{"description":"Output only. The time when the build state was updated last.","format":"google-datetime","readOnly":true,"type":"string"},"errorResult":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"imageSizeBytes":{"description":"Output only. The size of the image in bytes. Populated only after the build succeeds.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_RoutineReference":{"description":"Id path of a routine.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this routine.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this routine.","type":"string"},"routineId":{"description":"Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.","type":"string"}}},"bigquery_v2_Row":{"description":"A single row in the confusion matrix.","type":"object","properties":{"actualLabel":{"description":"The original label of this row.","type":"string"},"entries":{"description":"Info describing predicted label distribution.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Entry"}}}},"bigquery_v2_RowAccessPolicy":{"description":"Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.","type":"object","properties":{"creationTime":{"description":"Output only. The time when this row access policy was created, in milliseconds since the epoch.","format":"google-datetime","readOnly":true,"type":"string"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"filterPredicate":{"description":"Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0","type":"string"},"grantees":{"description":"Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - \"user:alice@example.com\": An email address that represents a specific Google account. - \"serviceAccount:my-other-app@appspot.gserviceaccount.com\": An email address that represents a service account. - \"group:admins@example.com\": An email address that represents a Google group. - \"domain:example.com\":The Google Workspace domain (primary) that represents all the users of that domain. - \"allAuthenticatedUsers\": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - \"allUsers\":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.","type":"array","items":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The time when this row access policy was last modified, in milliseconds since the epoch.","format":"google-datetime","readOnly":true,"type":"string"},"rowAccessPolicyReference":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicyReference"}}},"bigquery_v2_RowAccessPolicyReference":{"description":"Id path of a row access policy.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this row access policy.","type":"string"},"policyId":{"description":"Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this row access policy.","type":"string"},"tableId":{"description":"Required. The ID of the table containing this row access policy.","type":"string"}}},"bigquery_v2_RowLevelSecurityStatistics":{"description":"Statistics for row-level security.","type":"object","properties":{"rowLevelSecurityApplied":{"description":"Whether any accessed data was protected by row access policies.","type":"boolean"}}},"bigquery_v2_ScriptOptions":{"description":"Options related to script execution.","type":"object","properties":{"keyResultStatement":{"description":"Determines which statement in the script represents the \"key result\", used to populate the schema and query results of the script job. Default is LAST.","enum":["KEY_RESULT_STATEMENT_KIND_UNSPECIFIED","LAST","FIRST_SELECT"],"type":"string"},"statementByteBudget":{"description":"Limit on the number of bytes billed per statement. Exceeding this budget results in an error.","format":"int64","type":"string"},"statementTimeoutMs":{"description":"Timeout period for each statement in a script.","format":"int64","type":"string"}}},"bigquery_v2_ScriptStackFrame":{"description":"Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a \";\", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab \"snaps\" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.","type":"object","properties":{"endColumn":{"description":"Output only. One-based end column.","format":"int32","readOnly":true,"type":"integer"},"endLine":{"description":"Output only. One-based end line.","format":"int32","readOnly":true,"type":"integer"},"procedureId":{"description":"Output only. Name of the active procedure, empty if in a top-level script.","readOnly":true,"type":"string"},"startColumn":{"description":"Output only. One-based start column.","format":"int32","readOnly":true,"type":"integer"},"startLine":{"description":"Output only. One-based start line.","format":"int32","readOnly":true,"type":"integer"},"text":{"description":"Output only. Text of the current statement/expression.","readOnly":true,"type":"string"}}},"bigquery_v2_ScriptStatistics":{"description":"Job statistics specific to the child job of a script.","type":"object","properties":{"evaluationKind":{"description":"Whether this child job was a statement or expression.","enum":["EVALUATION_KIND_UNSPECIFIED","STATEMENT","EXPRESSION"],"type":"string"},"stackFrames":{"description":"Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ScriptStackFrame"}}}},"bigquery_v2_SearchStatistics":{"description":"Statistics for a search query. Populated as part of JobStatistics2.","type":"object","properties":{"indexPruningStats":{"description":"Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IndexPruningStats"}},"indexUnusedReasons":{"description":"When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IndexUnusedReason"}},"indexUsageMode":{"description":"Specifies the index usage mode for the query.","enum":["INDEX_USAGE_MODE_UNSPECIFIED","UNUSED","PARTIALLY_USED","FULLY_USED"],"type":"string"}}},"bigquery_v2_SecureContext":{"description":"A set of key-value pairs representing the secure context.","type":"object","properties":{"secureParameterEntries":{"description":"Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query.","type":"object","additionalProperties":{"description":"Properties of the object."}}}},"bigquery_v2_SerDeInfo":{"description":"Serializer and deserializer information.","type":"object","properties":{"name":{"description":"Optional. Name of the SerDe. The maximum length is 256 characters.","type":"string"},"parameters":{"description":"Optional. Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.","type":"object","additionalProperties":{"type":"string"}},"serializationLibrary":{"description":"Required. Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.","type":"string"}}},"bigquery_v2_SessionInfo":{"description":"[Preview] Information related to sessions.","type":"object","properties":{"sessionId":{"description":"Output only. The id of the session.","readOnly":true,"type":"string"}}},"bigquery_v2_SetIamPolicyRequest":{"description":"Request message for `SetIamPolicy` method.","type":"object","properties":{"policy":{"$ref":"#/components/schemas/bigquery_v2_Policy"},"updateMask":{"description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`","format":"google-fieldmask","type":"string"}}},"bigquery_v2_SkewSource":{"description":"Details about source stages which produce skewed data.","type":"object","properties":{"outputBytesMax":{"description":"Output only. Max partition output size (in bytes) for this stage.","format":"int64","readOnly":true,"type":"string"},"outputBytesMedian":{"description":"Output only. Median partition output size (in bytes) for this stage.","format":"int64","readOnly":true,"type":"string"},"outputBytesP95":{"description":"Output only. 95-th percentile of partition output size (in bytes) for this stage.","format":"int64","readOnly":true,"type":"string"},"stageId":{"description":"Output only. Stage id of the skew source stage.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_SnapshotDefinition":{"description":"Information about base table and snapshot time of the snapshot.","type":"object","properties":{"baseTableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"snapshotTime":{"description":"Required. The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.","format":"date-time","type":"string"}}},"bigquery_v2_SparkLoggingInfo":{"description":"Spark job logs can be filtered by these fields in Cloud Logging.","type":"object","properties":{"projectId":{"description":"Output only. Project ID where the Spark logs were written.","readOnly":true,"type":"string"},"resourceType":{"description":"Output only. Resource type used for logging.","readOnly":true,"type":"string"}}},"bigquery_v2_SparkOptions":{"description":"Options for a user-defined Spark routine.","type":"object","properties":{"archiveUris":{"description":"Archive files to be extracted into the working directory of each executor. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"connection":{"description":"Fully qualified name of the user-provided Spark connection object. Format: ```\"projects/{project_id}/locations/{location_id}/connections/{connection_id}\"```","type":"string"},"containerImage":{"description":"Custom container image for the runtime environment.","type":"string"},"fileUris":{"description":"Files to be placed in the working directory of each executor. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"jarUris":{"description":"JARs to include on the driver and executor CLASSPATH. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"mainClass":{"description":"The fully qualified name of a class in jar_uris, for example, com.example.wordcount. Exactly one of main_class and main_jar_uri field should be set for Java/Scala language type.","type":"string"},"mainFileUri":{"description":"The main file/jar URI of the Spark application. Exactly one of the definition_body field and the main_file_uri field must be set for Python. Exactly one of main_class and main_file_uri field should be set for Java/Scala language type.","type":"string"},"properties":{"description":"Configuration properties as a set of key/value pairs, which will be passed on to the Spark application. For more information, see [Apache Spark](https://spark.apache.org/docs/latest/index.html) and the [procedure option list](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#procedure_option_list).","type":"object","additionalProperties":{"type":"string"}},"pyFileUris":{"description":"Python files to be placed on the PYTHONPATH for PySpark application. Supported file types: `.py`, `.egg`, and `.zip`. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"runtimeVersion":{"description":"Runtime version. If not specified, the default runtime version is used.","type":"string"}}},"bigquery_v2_SparkStatistics":{"description":"Statistics for a BigSpark query. Populated as part of JobStatistics2","type":"object","properties":{"endpoints":{"description":"Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.","readOnly":true,"type":"object","additionalProperties":{"type":"string"}},"gcsStagingBucket":{"description":"Output only. The Google Cloud Storage bucket that is used as the default file system by the Spark application. This field is only filled when the Spark procedure uses the invoker security mode. The `gcsStagingBucket` bucket is inferred from the `@@spark_proc_properties.staging_bucket` system variable (if it is provided). Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]`","readOnly":true,"type":"string"},"kmsKeyName":{"description":"Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses the invoker security mode, the Cloud KMS encryption key is either inferred from the provided system variable, `@@spark_proc_properties.kms_key_name`, or the default key of the BigQuery job's project (if the CMEK organization policy is enforced). Otherwise, the Cloud KMS key is either inferred from the Spark connection associated with the procedure (if it is provided), or from the default key of the Spark connection's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]`","readOnly":true,"type":"string"},"loggingInfo":{"$ref":"#/components/schemas/bigquery_v2_SparkLoggingInfo"},"sparkJobId":{"description":"Output only. Spark job ID if a Spark job is created successfully.","readOnly":true,"type":"string"},"sparkJobLocation":{"description":"Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region.","readOnly":true,"type":"string"}}},"bigquery_v2_StagePerformanceChangeInsight":{"description":"Performance insights compared to the previous executions for a specific stage.","type":"object","properties":{"inputDataChange":{"$ref":"#/components/schemas/bigquery_v2_InputDataChange"},"stageId":{"description":"Output only. The stage id that the insight mapped to.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_StagePerformanceStandaloneInsight":{"description":"Standalone performance insights for a specific stage.","type":"object","properties":{"biEngineReasons":{"description":"Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BiEngineReason"}},"highCardinalityJoins":{"description":"Output only. High cardinality joins in the stage.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_HighCardinalityJoin"}},"insufficientShuffleQuota":{"description":"Output only. True if the stage has insufficient shuffle quota.","readOnly":true,"type":"boolean"},"partitionSkew":{"$ref":"#/components/schemas/bigquery_v2_PartitionSkew"},"slotContention":{"description":"Output only. True if the stage has a slot contention issue.","readOnly":true,"type":"boolean"},"stageId":{"description":"Output only. The stage id that the insight mapped to.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_StandardSqlDataType":{"description":"The data type of a variable such as a function argument. Examples include: * INT64: `{\"typeKind\": \"INT64\"}` * ARRAY: { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"STRING\"} } * STRUCT>: { \"typeKind\": \"STRUCT\", \"structType\": { \"fields\": [ { \"name\": \"x\", \"type\": {\"typeKind\": \"STRING\"} }, { \"name\": \"y\", \"type\": { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"DATE\"} } } ] } } * RANGE: { \"typeKind\": \"RANGE\", \"rangeElementType\": {\"typeKind\": \"DATE\"} }","type":"object","properties":{"arrayElementType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"rangeElementType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"structType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlStructType"},"typeKind":{"description":"Required. The top level type of this field. Can be any GoogleSQL data type (e.g., \"INT64\", \"DATE\", \"ARRAY\").","enum":["TYPE_KIND_UNSPECIFIED","INT64","BOOL","FLOAT64","STRING","BYTES","TIMESTAMP","DATE","TIME","DATETIME","INTERVAL","GEOGRAPHY","NUMERIC","BIGNUMERIC","JSON","ARRAY","STRUCT","RANGE","UUID"],"type":"string"}}},"bigquery_v2_StandardSqlField":{"description":"A field or a column.","type":"object","properties":{"name":{"description":"Optional. The name of this field. Can be absent for struct fields.","type":"string"},"type":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"}}},"bigquery_v2_StandardSqlStructType":{"description":"The representation of a SQL STRUCT type.","type":"object","properties":{"fields":{"description":"Fields within the struct.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}}}},"bigquery_v2_StandardSqlTableType":{"description":"A table type","type":"object","properties":{"columns":{"description":"The columns in this table type","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}}}},"bigquery_v2_StorageDescriptor":{"description":"Contains information about how a table's data is stored and accessed by open source query engines.","type":"object","properties":{"inputFormat":{"description":"Optional. Specifies the fully qualified class name of the InputFormat (e.g. \"org.apache.hadoop.hive.ql.io.orc.OrcInputFormat\"). The maximum length is 128 characters.","type":"string"},"locationUri":{"description":"Optional. The physical location of the table (e.g. `gs://spark-dataproc-data/pangea-data/case_sensitive/` or `gs://spark-dataproc-data/pangea-data/*`). The maximum length is 2056 bytes.","type":"string"},"outputFormat":{"description":"Optional. Specifies the fully qualified class name of the OutputFormat (e.g. \"org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat\"). The maximum length is 128 characters.","type":"string"},"serdeInfo":{"$ref":"#/components/schemas/bigquery_v2_SerDeInfo"}}},"bigquery_v2_StoredColumnsUnusedReason":{"description":"If the stored column was not used, explain why.","type":"object","properties":{"code":{"description":"Specifies the high-level reason for the unused scenario, each reason must have a code associated.","enum":["CODE_UNSPECIFIED","STORED_COLUMNS_COVER_INSUFFICIENT","BASE_TABLE_HAS_RLS","BASE_TABLE_HAS_CLS","UNSUPPORTED_PREFILTER","INTERNAL_ERROR","OTHER_REASON"],"type":"string"},"message":{"description":"Specifies the detailed description for the scenario.","type":"string"},"uncoveredColumns":{"description":"Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS.","type":"array","items":{"type":"string"}}}},"bigquery_v2_StoredColumnsUsage":{"description":"Indicates the stored columns usage in the query.","type":"object","properties":{"baseTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"isQueryAccelerated":{"description":"Specifies whether the query was accelerated with stored columns.","type":"boolean"},"storedColumnsUnusedReasons":{"description":"If stored columns were not used, explain why.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StoredColumnsUnusedReason"}}}},"bigquery_v2_Streamingbuffer":{"type":"object","properties":{"estimatedBytes":{"description":"Output only. A lower-bound estimate of the number of bytes currently in the streaming buffer.","format":"uint64","readOnly":true,"type":"string"},"estimatedRows":{"description":"Output only. A lower-bound estimate of the number of rows currently in the streaming buffer.","format":"uint64","readOnly":true,"type":"string"},"oldestEntryTime":{"description":"Output only. Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.","format":"uint64","readOnly":true,"type":"string"}}},"bigquery_v2_StringHparamSearchSpace":{"description":"Search space for string and enum.","type":"object","properties":{"candidates":{"description":"Canididates for the string or enum parameter in lower case.","type":"array","items":{"type":"string"}}}},"bigquery_v2_SystemVariables":{"description":"System variables given to a query.","type":"object","properties":{"types":{"description":"Output only. Data type for each system variable.","readOnly":true,"type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"}},"values":{"description":"Output only. Value for each system variable.","readOnly":true,"type":"object","additionalProperties":{"description":"Properties of the object."}}}},"bigquery_v2_Table":{"type":"object","properties":{"biglakeConfiguration":{"$ref":"#/components/schemas/bigquery_v2_BigLakeConfiguration"},"cloneDefinition":{"$ref":"#/components/schemas/bigquery_v2_CloneDefinition"},"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"creationTime":{"description":"Output only. The time when this table was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"defaultCollation":{"description":"Optional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.","type":"string"},"defaultRoundingMode":{"description":"Optional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn't affect existing fields.","enum":["ROUNDING_MODE_UNSPECIFIED","ROUND_HALF_AWAY_FROM_ZERO","ROUND_HALF_EVEN"],"type":"string"},"description":{"description":"Optional. A user-friendly description of this table.","type":"string"},"encryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"expirationTime":{"description":"Optional. The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.","format":"int64","type":"string"},"externalCatalogTableOptions":{"$ref":"#/components/schemas/bigquery_v2_ExternalCatalogTableOptions"},"externalDataConfiguration":{"$ref":"#/components/schemas/bigquery_v2_ExternalDataConfiguration"},"friendlyName":{"description":"Optional. A descriptive name for this table.","type":"string"},"id":{"description":"Output only. An opaque ID uniquely identifying the table.","readOnly":true,"type":"string"},"kind":{"description":"The type of resource ID.","default":"bigquery#table","type":"string"},"labels":{"description":"The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The time when this table was last modified, in milliseconds since the epoch.","format":"uint64","readOnly":true,"type":"string"},"location":{"description":"Output only. The geographic location where the table resides. This value is inherited from the dataset.","readOnly":true,"type":"string"},"managedTableType":{"description":"Optional. If set, overrides the default managed table type configured in the dataset.","enum":["MANAGED_TABLE_TYPE_UNSPECIFIED","NATIVE","BIGLAKE"],"type":"string"},"materializedView":{"$ref":"#/components/schemas/bigquery_v2_MaterializedViewDefinition"},"materializedViewStatus":{"$ref":"#/components/schemas/bigquery_v2_MaterializedViewStatus"},"maxStaleness":{"description":"Optional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type.","type":"string"},"model":{"$ref":"#/components/schemas/bigquery_v2_ModelDefinition"},"numActiveLogicalBytes":{"description":"Output only. Number of logical bytes that are less than 90 days old.","format":"int64","readOnly":true,"type":"string"},"numActivePhysicalBytes":{"description":"Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numBytes":{"description":"Output only. The size of this table in logical bytes, excluding any data in the streaming buffer.","format":"int64","readOnly":true,"type":"string"},"numCurrentPhysicalBytes":{"description":"Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numLongTermBytes":{"description":"Output only. The number of logical bytes in the table that are considered \"long-term storage\".","format":"int64","readOnly":true,"type":"string"},"numLongTermLogicalBytes":{"description":"Output only. Number of logical bytes that are more than 90 days old.","format":"int64","readOnly":true,"type":"string"},"numLongTermPhysicalBytes":{"description":"Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numPartitions":{"description":"Output only. The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numPhysicalBytes":{"description":"Output only. The physical size of this table in bytes. This includes storage used for time travel.","format":"int64","readOnly":true,"type":"string"},"numRows":{"description":"Output only. The number of rows of data in this table, excluding any data in the streaming buffer.","format":"uint64","readOnly":true,"type":"string"},"numTimeTravelPhysicalBytes":{"description":"Output only. Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numTotalLogicalBytes":{"description":"Output only. Total number of logical bytes in the table or materialized view.","format":"int64","readOnly":true,"type":"string"},"numTotalPhysicalBytes":{"description":"Output only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"partitionDefinition":{"$ref":"#/components/schemas/bigquery_v2_PartitioningDefinition"},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"replicas":{"description":"Optional. Output only. Table references of all replicas currently active on the table.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"requirePartitionFilter":{"description":"Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.","default":false,"type":"boolean"},"resourceTags":{"description":"[Optional] The tags associated with this table. Tag keys are globally unique. See additional information on [tags](https://cloud.google.com/iam/docs/tags-access-control#definitions). An object containing a list of \"key\": value pairs. The key is the namespaced friendly name of the tag key, e.g. \"12345/environment\" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. \"production\".","type":"object","additionalProperties":{"type":"string"}},"restrictions":{"$ref":"#/components/schemas/bigquery_v2_RestrictionConfig"},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"selfLink":{"description":"Output only. A URL that can be used to access this resource again.","readOnly":true,"type":"string"},"snapshotDefinition":{"$ref":"#/components/schemas/bigquery_v2_SnapshotDefinition"},"streamingBuffer":{"$ref":"#/components/schemas/bigquery_v2_Streamingbuffer"},"tableConstraints":{"$ref":"#/components/schemas/bigquery_v2_TableConstraints"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"tableReplicationInfo":{"$ref":"#/components/schemas/bigquery_v2_TableReplicationInfo"},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"type":{"description":"Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](https://cloud.google.com/bigquery/docs/table-snapshots-intro). The default value is `TABLE`.","readOnly":true,"type":"string"},"view":{"$ref":"#/components/schemas/bigquery_v2_ViewDefinition"}}},"bigquery_v2_TableCell":{"type":"object","properties":{"v":{}}},"bigquery_v2_TableChangeInsight":{"description":"Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table.","type":"object","properties":{"metadataCacheNotUsedButUsedPreviously":{"description":"Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash.","readOnly":true,"type":"boolean"},"metadataCacheStalenessInsight":{"$ref":"#/components/schemas/bigquery_v2_MetadataCacheStalenessInsight"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_TableConstraints":{"description":"The TableConstraints defines the primary key and foreign key.","type":"object","properties":{"foreignKeys":{"description":"Optional. Present only if the table has a foreign key. The foreign key is not enforced.","type":"array","items":{"description":"Represents a foreign key constraint on a table's columns.","type":"object","properties":{"columnReferences":{"description":"Required. The columns that compose the foreign key.","type":"array","items":{"description":"The pair of the foreign key column and primary key column.","type":"object","properties":{"referencedColumn":{"description":"Required. The column in the primary key that are referenced by the referencing_column.","type":"string"},"referencingColumn":{"description":"Required. The column that composes the foreign key.","type":"string"}}}},"name":{"description":"Optional. Set only if the foreign key constraint is named.","type":"string"},"referencedTable":{"type":"object","properties":{"datasetId":{"type":"string"},"projectId":{"type":"string"},"tableId":{"type":"string"}}}}}},"primaryKey":{"description":"Represents the primary key constraint on a table's columns.","type":"object","properties":{"columns":{"description":"Required. The columns that are composed of the primary key constraint.","type":"array","items":{"type":"string"}}}}}},"bigquery_v2_TableDataInsertAllRequest":{"description":"Request for sending a single streaming insert.","type":"object","properties":{"ignoreUnknownValues":{"description":"Optional. Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.","type":"boolean"},"kind":{"description":"Optional. The resource type of the response. The value is not checked at the backend. Historically, it has been set to \"bigquery#tableDataInsertAllRequest\" but you are not required to set it.","default":"bigquery#tableDataInsertAllRequest","type":"string"},"rows":{"type":"array","items":{"description":"Data for a single insertion row.","type":"object","properties":{"insertId":{"description":"Insertion ID for best-effort deduplication. This feature is not recommended, and users seeking stronger insertion semantics are encouraged to use other mechanisms such as the BigQuery Write API.","type":"string"},"json":{"$ref":"#/components/schemas/bigquery_v2_JsonObject"}}}},"skipInvalidRows":{"description":"Optional. Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.","type":"boolean"},"templateSuffix":{"description":"Optional. If specified, treats the destination table as a base template, and inserts the rows into an instance table named \"{destination}{templateSuffix}\". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.","type":"string"},"traceId":{"description":"Optional. Unique request trace id. Used for debugging purposes only. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended.","type":"string"}}},"bigquery_v2_TableDataInsertAllResponse":{"description":"Describes the format of a streaming insert response.","type":"object","properties":{"insertErrors":{"description":"Describes specific errors encountered while processing the request.","type":"array","items":{"description":"Error details about a single row's insertion.","type":"object","properties":{"errors":{"description":"Error information for the row indicated by the index property.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"index":{"description":"The index of the row that error applies to.","format":"uint32","type":"integer"}}}},"kind":{"description":"Returns \"bigquery#tableDataInsertAllResponse\".","default":"bigquery#tableDataInsertAllResponse","type":"string"}}},"bigquery_v2_TableDataList":{"type":"object","properties":{"etag":{"description":"A hash of this page of results.","type":"string"},"kind":{"description":"The resource type of the response.","default":"bigquery#tableDataList","type":"string"},"pageToken":{"description":"A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.","type":"string"},"rows":{"description":"Rows of results.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableRow"}},"totalRows":{"description":"Total rows of the entire table. In order to show default value 0 we have to present it as string.","format":"int64","type":"string"}}},"bigquery_v2_TableFieldSchema":{"description":"A field in TableSchema","type":"object","properties":{"categories":{"description":"Deprecated.","type":"object","properties":{"names":{"description":"Deprecated.","type":"array","items":{"type":"string"}}}},"collation":{"description":"Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.","type":"string"},"dataGovernanceTagsInfo":{"description":"Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: * **Precedence**: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. * **Patching behavior**: Describes how this field behaves during a `Table.patch` schema update: * **Unset**: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. * **Empty Field**: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This removes all tags from the column. * **Updating tags**: To replace an existing tag, send the field with the new tag.","type":"object","properties":{"dataGovernanceTags":{"description":"Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"parent-id/pii\" where parent-id is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"sensitive\". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: \"parent-id/pii\": \"sensitive\", \"myProject/cost_center\": \"sales\"","type":"object","additionalProperties":{"type":"string"}}}},"dataPolicies":{"description":"Optional. Data policies attached to this field, used for field-level access control.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_DataPolicyOption"}},"dataPolicyList":{"$ref":"#/components/schemas/bigquery_v2_DataPolicyList"},"defaultValueExpression":{"description":"Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.","type":"string"},"description":{"description":"Optional. The field description. The maximum length is 1,024 characters.","type":"string"},"fields":{"description":"Optional. Describes the nested schema fields if the type property is set to RECORD.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableFieldSchema"}},"foreignTypeDefinition":{"description":"Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.","type":"string"},"generatedColumn":{"$ref":"#/components/schemas/bigquery_v2_GeneratedColumn"},"maxLength":{"description":"Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = \"STRING\", then max_length represents the maximum UTF-8 length of strings in this field. If type = \"BYTES\", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ \"STRING\" and ≠ \"BYTES\".","format":"int64","type":"string"},"mode":{"description":"Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.","type":"string"},"name":{"description":"Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.","type":"string"},"policyTags":{"description":"Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.","type":"object","properties":{"names":{"description":"A list of policy tag resource names. For example, \"projects/1/locations/eu/taxonomies/2/policyTags/3\". At most 1 policy tag is currently allowed.","type":"array","items":{"type":"string"}}}},"precision":{"description":"Optional. Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ \"NUMERIC\" and ≠ \"BIGNUMERIC\". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: * Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] * Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: * If type = \"NUMERIC\": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. * If type = \"BIGNUMERIC\": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): * If type = \"NUMERIC\": 1 ≤ precision ≤ 29. * If type = \"BIGNUMERIC\": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.","format":"int64","type":"string"},"rangeElementType":{"description":"Represents the type of a field element.","type":"object","properties":{"type":{"description":"Required. The type of a field element. For more information, see TableFieldSchema.type.","type":"string"}}},"roundingMode":{"description":"Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.","enum":["ROUNDING_MODE_UNSPECIFIED","ROUND_HALF_AWAY_FROM_ZERO","ROUND_HALF_EVEN"],"type":"string"},"scale":{"description":"Optional. See documentation for precision.","format":"int64","type":"string"},"timestampPrecision":{"description":"Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)","format":"int64","default":"6","type":"string"},"type":{"description":"Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema.","type":"string"}}},"bigquery_v2_TableList":{"description":"Partial projection of the metadata for a given table in a list response.","type":"object","properties":{"etag":{"description":"A hash of this page of results.","type":"string"},"kind":{"description":"The type of list.","default":"bigquery#tableList","type":"string"},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"tables":{"description":"Tables in the requested dataset.","type":"array","items":{"type":"object","properties":{"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"creationTime":{"description":"Output only. The time when this table was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"expirationTime":{"description":"The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.","format":"int64","type":"string"},"friendlyName":{"description":"The user-friendly name for this table.","type":"string"},"id":{"description":"An opaque ID of the table.","type":"string"},"kind":{"description":"The resource type.","type":"string"},"labels":{"description":"The labels associated with this table. You can use these to organize and group your tables.","type":"object","additionalProperties":{"type":"string"}},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"requirePartitionFilter":{"description":"Optional. If set to true, queries including this table must specify a partition filter. This filter is used for partition elimination.","default":false,"type":"boolean"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"type":{"description":"The type of table.","type":"string"},"view":{"description":"Information about a logical view.","type":"object","properties":{"privacyPolicy":{"$ref":"#/components/schemas/bigquery_v2_PrivacyPolicy"},"useLegacySql":{"description":"True if view is defined in legacy SQL dialect, false if in GoogleSQL.","type":"boolean"}}}}}},"totalItems":{"description":"The total number of tables in the dataset.","format":"int32","type":"integer"}}},"bigquery_v2_TableMetadataCacheUsage":{"description":"Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.","type":"object","properties":{"explanation":{"description":"Free form human-readable reason metadata caching was unused for the job.","type":"string"},"pruningStats":{"$ref":"#/components/schemas/bigquery_v2_PruningStats"},"staleness":{"description":"Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).","format":"google-duration","type":"string"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"tableType":{"description":"[Table type](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).","type":"string"},"unusedReason":{"description":"Reason for not using metadata caching for the table.","enum":["UNUSED_REASON_UNSPECIFIED","EXCEEDED_MAX_STALENESS","METADATA_CACHING_NOT_ENABLED","OTHER_REASON"],"type":"string"}}},"bigquery_v2_TableReference":{"type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this table.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this table.","type":"string"},"tableId":{"description":"Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`.","type":"string"}}},"bigquery_v2_TableReplicationInfo":{"description":"Replication info of a table created using `AS REPLICA` DDL like: `CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv`","type":"object","properties":{"replicatedSourceLastRefreshTime":{"description":"Optional. Output only. If source is a materialized view, this field signifies the last refresh time of the source.","format":"int64","readOnly":true,"type":"string"},"replicationError":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"replicationIntervalMs":{"description":"Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied.","format":"int64","type":"string"},"replicationStatus":{"description":"Optional. Output only. Replication status of configured replication.","readOnly":true,"enum":["REPLICATION_STATUS_UNSPECIFIED","ACTIVE","SOURCE_DELETED","PERMISSION_DENIED","UNSUPPORTED_CONFIGURATION"],"type":"string"},"sourceTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_TableRow":{"type":"object","properties":{"f":{"description":"Represents a single row in the result set, consisting of one or more fields.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableCell"}}}},"bigquery_v2_TableSchema":{"description":"Schema of a table","type":"object","properties":{"fields":{"description":"Describes the fields in a table.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableFieldSchema"}},"foreignTypeInfo":{"$ref":"#/components/schemas/bigquery_v2_ForeignTypeInfo"}}},"bigquery_v2_TestIamPermissionsRequest":{"description":"Request message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).","type":"array","items":{"type":"string"}}}},"bigquery_v2_TestIamPermissionsResponse":{"description":"Response message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"A subset of `TestPermissionsRequest.permissions` that the caller is allowed.","type":"array","items":{"type":"string"}}}},"bigquery_v2_TimePartitioning":{"type":"object","properties":{"expirationMs":{"description":"Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.","format":"int64","type":"string"},"field":{"description":"Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.","type":"string"},"requirePartitionFilter":{"description":"If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.","default":false,"type":"boolean"},"type":{"description":"Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.","type":"string"}}},"bigquery_v2_TrainingOptions":{"description":"Options used in model training.","type":"object","properties":{"activationFn":{"description":"Activation function of the neural nets.","type":"string"},"adjustStepChanges":{"description":"If true, detect step changes and make data adjustment in the input time series.","type":"boolean"},"approxGlobalFeatureContrib":{"description":"Whether to use approximate feature contribution method in XGBoost model explanation for global explain.","type":"boolean"},"autoArima":{"description":"Whether to enable auto ARIMA or not.","type":"boolean"},"autoArimaMaxOrder":{"description":"The max value of the sum of non-seasonal p and q.","format":"int64","type":"string"},"autoArimaMinOrder":{"description":"The min value of the sum of non-seasonal p and q.","format":"int64","type":"string"},"autoClassWeights":{"description":"Whether to calculate class weights automatically based on the popularity of each label.","type":"boolean"},"batchSize":{"description":"Batch size for dnn models.","format":"int64","type":"string"},"boosterType":{"description":"Booster type for boosted tree models.","enum":["BOOSTER_TYPE_UNSPECIFIED","GBTREE","DART"],"type":"string"},"budgetHours":{"description":"Budget in hours for AutoML training.","format":"double","type":"number"},"calculatePValues":{"description":"Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.","type":"boolean"},"categoryEncodingMethod":{"description":"Categorical feature encoding method.","enum":["ENCODING_METHOD_UNSPECIFIED","ONE_HOT_ENCODING","LABEL_ENCODING","DUMMY_ENCODING"],"type":"string"},"cleanSpikesAndDips":{"description":"If true, clean spikes and dips in the input time series.","type":"boolean"},"colorSpace":{"description":"Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.","enum":["COLOR_SPACE_UNSPECIFIED","RGB","HSV","YIQ","YUV","GRAYSCALE"],"type":"string"},"colsampleBylevel":{"description":"Subsample ratio of columns for each level for boosted tree models.","format":"double","type":"number"},"colsampleBynode":{"description":"Subsample ratio of columns for each node(split) for boosted tree models.","format":"double","type":"number"},"colsampleBytree":{"description":"Subsample ratio of columns when constructing each tree for boosted tree models.","format":"double","type":"number"},"contributionMetric":{"description":"The contribution metric. Applies to contribution analysis models. Allowed formats supported are for summable and summable ratio contribution metrics. These include expressions such as `SUM(x)` or `SUM(x)/SUM(y)`, where x and y are column names from the base table.","type":"string"},"dartNormalizeType":{"description":"Type of normalization algorithm for boosted tree models using dart booster.","enum":["DART_NORMALIZE_TYPE_UNSPECIFIED","TREE","FOREST"],"type":"string"},"dataFrequency":{"description":"The data frequency of a time series.","enum":["DATA_FREQUENCY_UNSPECIFIED","AUTO_FREQUENCY","YEARLY","QUARTERLY","MONTHLY","WEEKLY","DAILY","HOURLY","PER_MINUTE"],"type":"string"},"dataSplitColumn":{"description":"The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data_type_properties","type":"string"},"dataSplitEvalFraction":{"description":"The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.","format":"double","type":"number"},"dataSplitMethod":{"description":"The data split type for training and evaluation, e.g. RANDOM.","enum":["DATA_SPLIT_METHOD_UNSPECIFIED","RANDOM","CUSTOM","SEQUENTIAL","NO_SPLIT","AUTO_SPLIT"],"type":"string"},"decomposeTimeSeries":{"description":"If true, perform decompose time series and save the results.","type":"boolean"},"dimensionIdColumns":{"description":"Optional. Names of the columns to slice on. Applies to contribution analysis models.","type":"array","items":{"type":"string"}},"distanceType":{"description":"Distance type for clustering models.","enum":["DISTANCE_TYPE_UNSPECIFIED","EUCLIDEAN","COSINE"],"type":"string"},"dropout":{"description":"Dropout probability for dnn models.","format":"double","type":"number"},"earlyStop":{"description":"Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.","type":"boolean"},"enableGlobalExplain":{"description":"If true, enable global explanation during training.","type":"boolean"},"endpointIdleTtl":{"description":"The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours.","format":"google-duration","type":"string"},"feedbackType":{"description":"Feedback type that specifies which algorithm to run for matrix factorization.","enum":["FEEDBACK_TYPE_UNSPECIFIED","IMPLICIT","EXPLICIT"],"type":"string"},"fitIntercept":{"description":"Whether the model should include intercept during model training.","type":"boolean"},"forecastLimitLowerBound":{"description":"The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html","format":"double","type":"number"},"forecastLimitUpperBound":{"description":"The forecast limit upper bound that was used during ARIMA model training with limits.","format":"double","type":"number"},"hiddenUnits":{"description":"Hidden units for dnn models.","type":"array","items":{"format":"int64","type":"string"}},"holidayRegion":{"description":"The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.","enum":["HOLIDAY_REGION_UNSPECIFIED","GLOBAL","NA","JAPAC","EMEA","LAC","AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CS","CZ","DE","DK","DZ","EC","EE","EG","ES","FI","FR","GB","GR","HK","HU","ID","IE","IL","IN","IR","IT","JP","KR","LV","MA","MX","MY","NG","NL","NO","NZ","PE","PH","PK","PL","PT","RO","RS","RU","SA","SE","SG","SI","SK","TH","TR","TW","UA","US","VE","VN","ZA"],"type":"string"},"holidayRegions":{"description":"A list of geographical regions that are used for time series modeling.","type":"array","items":{"enum":["HOLIDAY_REGION_UNSPECIFIED","GLOBAL","NA","JAPAC","EMEA","LAC","AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CS","CZ","DE","DK","DZ","EC","EE","EG","ES","FI","FR","GB","GR","HK","HU","ID","IE","IL","IN","IR","IT","JP","KR","LV","MA","MX","MY","NG","NL","NO","NZ","PE","PH","PK","PL","PT","RO","RS","RU","SA","SE","SG","SI","SK","TH","TR","TW","UA","US","VE","VN","ZA"],"type":"string"}},"horizon":{"description":"The number of periods ahead that need to be forecasted.","format":"int64","type":"string"},"hparamTuningObjectives":{"description":"The target evaluation metrics to optimize the hyperparameters for.","type":"array","items":{"enum":["HPARAM_TUNING_OBJECTIVE_UNSPECIFIED","MEAN_ABSOLUTE_ERROR","MEAN_SQUARED_ERROR","MEAN_SQUARED_LOG_ERROR","MEDIAN_ABSOLUTE_ERROR","R_SQUARED","EXPLAINED_VARIANCE","PRECISION","RECALL","ACCURACY","F1_SCORE","LOG_LOSS","ROC_AUC","DAVIES_BOULDIN_INDEX","MEAN_AVERAGE_PRECISION","NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN","AVERAGE_RANK"],"type":"string"}},"huggingFaceModelId":{"description":"The id of a Hugging Face model. For example, `google/gemma-2-2b-it`.","type":"string"},"includeDrift":{"description":"Include drift when fitting an ARIMA model.","type":"boolean"},"initialLearnRate":{"description":"Specifies the initial learning rate for the line search learn rate strategy.","format":"double","type":"number"},"inputLabelColumns":{"description":"Name of input label columns in training data.","type":"array","items":{"type":"string"}},"instanceWeightColumn":{"description":"Name of the instance weight column for training data. This column isn't be used as a feature.","type":"string"},"integratedGradientsNumSteps":{"description":"Number of integral steps for the integrated gradients explain method.","format":"int64","type":"string"},"isTestColumn":{"description":"Name of the column used to determine the rows corresponding to control and test. Applies to contribution analysis models.","type":"string"},"itemColumn":{"description":"Item column specified for matrix factorization models.","type":"string"},"kmeansInitializationColumn":{"description":"The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.","type":"string"},"kmeansInitializationMethod":{"description":"The method used to initialize the centroids for kmeans algorithm.","enum":["KMEANS_INITIALIZATION_METHOD_UNSPECIFIED","RANDOM","CUSTOM","KMEANS_PLUS_PLUS"],"type":"string"},"l1RegActivation":{"description":"L1 regularization coefficient to activations.","format":"double","type":"number"},"l1Regularization":{"description":"L1 regularization coefficient.","format":"double","type":"number"},"l2Regularization":{"description":"L2 regularization coefficient.","format":"double","type":"number"},"labelClassWeights":{"description":"Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.","type":"object","additionalProperties":{"format":"double","type":"number"}},"learnRate":{"description":"Learning rate in training. Used only for iterative training algorithms.","format":"double","type":"number"},"learnRateStrategy":{"description":"The strategy to determine learn rate for the current iteration.","enum":["LEARN_RATE_STRATEGY_UNSPECIFIED","LINE_SEARCH","CONSTANT"],"type":"string"},"lossType":{"description":"Type of loss function used during training run.","enum":["LOSS_TYPE_UNSPECIFIED","MEAN_SQUARED_LOSS","MEAN_LOG_LOSS"],"type":"string"},"machineType":{"description":"The type of the machine used to deploy and serve the model.","type":"string"},"maxIterations":{"description":"The maximum number of iterations in training. Used only for iterative training algorithms.","format":"int64","type":"string"},"maxParallelTrials":{"description":"Maximum number of trials to run in parallel.","format":"int64","type":"string"},"maxReplicaCount":{"description":"The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count.","format":"int64","type":"string"},"maxTimeSeriesLength":{"description":"The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.","format":"int64","type":"string"},"maxTreeDepth":{"description":"Maximum depth of a tree for boosted tree models.","format":"int64","type":"string"},"minAprioriSupport":{"description":"The apriori support minimum. Applies to contribution analysis models.","format":"double","type":"number"},"minRelativeProgress":{"description":"When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.","format":"double","type":"number"},"minReplicaCount":{"description":"The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1.","format":"int64","type":"string"},"minSplitLoss":{"description":"Minimum split loss for boosted tree models.","format":"double","type":"number"},"minTimeSeriesLength":{"description":"The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points.","format":"int64","type":"string"},"minTreeChildWeight":{"description":"Minimum sum of instance weight needed in a child for boosted tree models.","format":"int64","type":"string"},"modelGardenModelName":{"description":"The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`.","type":"string"},"modelRegistry":{"description":"The model registry.","enum":["MODEL_REGISTRY_UNSPECIFIED","VERTEX_AI"],"type":"string"},"modelUri":{"description":"Google Cloud Storage URI from which the model was imported. Only applicable for imported models.","type":"string"},"nonSeasonalOrder":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"},"numClusters":{"description":"Number of clusters for clustering models.","format":"int64","type":"string"},"numFactors":{"description":"Num factors specified for matrix factorization models.","format":"int64","type":"string"},"numParallelTree":{"description":"Number of parallel trees constructed during each iteration for boosted tree models.","format":"int64","type":"string"},"numPrincipalComponents":{"description":"Number of principal components to keep in the PCA model. Must be <= the number of features.","format":"int64","type":"string"},"numTrials":{"description":"Number of trials to run this hyperparameter tuning job.","format":"int64","type":"string"},"optimizationStrategy":{"description":"Optimization strategy for training linear regression models.","enum":["OPTIMIZATION_STRATEGY_UNSPECIFIED","BATCH_GRADIENT_DESCENT","NORMAL_EQUATION"],"type":"string"},"optimizer":{"description":"Optimizer used for training the neural nets.","type":"string"},"pcaExplainedVarianceRatio":{"description":"The minimum ratio of cumulative explained variance that needs to be given by the PCA model.","format":"double","type":"number"},"pcaSolver":{"description":"The solver for PCA.","enum":["UNSPECIFIED","FULL","RANDOMIZED","AUTO"],"type":"string"},"reservationAffinityKey":{"description":"Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.","type":"string"},"reservationAffinityType":{"description":"Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`.","enum":["RESERVATION_AFFINITY_TYPE_UNSPECIFIED","NO_RESERVATION","ANY_RESERVATION","SPECIFIC_RESERVATION"],"type":"string"},"reservationAffinityValues":{"description":"Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block.","type":"array","items":{"type":"string"}},"sampledShapleyNumPaths":{"description":"Number of paths for the sampled Shapley explain method.","format":"int64","type":"string"},"scaleFeatures":{"description":"If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.","type":"boolean"},"standardizeFeatures":{"description":"Whether to standardize numerical features. Default to true.","type":"boolean"},"subsample":{"description":"Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.","format":"double","type":"number"},"tfVersion":{"description":"Based on the selected TF version, the corresponding docker image is used to train external models.","type":"string"},"timeSeriesDataColumn":{"description":"Column to be designated as time series data for ARIMA model.","type":"string"},"timeSeriesIdColumn":{"description":"The time series id column that was used during ARIMA model training.","type":"string"},"timeSeriesIdColumns":{"description":"The time series id columns that were used during ARIMA model training.","type":"array","items":{"type":"string"}},"timeSeriesLengthFraction":{"description":"The fraction of the interpolated length of the time series that's used to model the time series trend component. All of the time points of the time series are used to model the non-trend component. This training option accelerates modeling training without sacrificing much forecasting accuracy. You can use this option with `minTimeSeriesLength` but not with `maxTimeSeriesLength`.","format":"double","type":"number"},"timeSeriesTimestampColumn":{"description":"Column to be designated as time series timestamp for ARIMA model.","type":"string"},"treeMethod":{"description":"Tree construction algorithm for boosted tree models.","enum":["TREE_METHOD_UNSPECIFIED","AUTO","EXACT","APPROX","HIST"],"type":"string"},"trendSmoothingWindowSize":{"description":"Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied.","format":"int64","type":"string"},"userColumn":{"description":"User column specified for matrix factorization models.","type":"string"},"vertexAiModelVersionAliases":{"description":"The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.","type":"array","items":{"type":"string"}},"walsAlpha":{"description":"Hyperparameter for matrix factoration when implicit feedback type is specified.","format":"double","type":"number"},"warmStart":{"description":"Whether to train a model from the last checkpoint.","type":"boolean"},"xgboostVersion":{"description":"User-selected XGBoost versions for training of XGBoost models.","type":"string"}}},"bigquery_v2_TrainingRun":{"description":"Information about a single training query run for the model.","type":"object","properties":{"classLevelGlobalExplanations":{"description":"Output only. Global explanation contains the explanation of top features on the class level. Applies to classification models only.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_GlobalExplanation"}},"dataSplitResult":{"$ref":"#/components/schemas/bigquery_v2_DataSplitResult"},"evaluationMetrics":{"$ref":"#/components/schemas/bigquery_v2_EvaluationMetrics"},"modelLevelGlobalExplanation":{"$ref":"#/components/schemas/bigquery_v2_GlobalExplanation"},"results":{"description":"Output only. Output of each iteration run, results.size() <= max_iterations.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IterationResult"}},"startTime":{"description":"Output only. The start time of this training run.","format":"google-datetime","readOnly":true,"type":"string"},"trainingOptions":{"$ref":"#/components/schemas/bigquery_v2_TrainingOptions"},"trainingStartTime":{"description":"Output only. The start time of this training run, in milliseconds since epoch.","format":"int64","readOnly":true,"type":"string"},"vertexAiModelId":{"description":"The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-registry/introduction) for this training run.","type":"string"},"vertexAiModelVersion":{"description":"Output only. The model version in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-registry/introduction) for this training run.","readOnly":true,"type":"string"}}},"bigquery_v2_TransactionInfo":{"description":"[Alpha] Information of a multi-statement transaction.","type":"object","properties":{"transactionId":{"description":"Output only. [Alpha] Id of the transaction.","readOnly":true,"type":"string"}}},"bigquery_v2_TransformColumn":{"description":"Information about a single transform column.","type":"object","properties":{"name":{"description":"Output only. Name of the column.","readOnly":true,"type":"string"},"transformSql":{"description":"Output only. The SQL expression used in the column transform.","readOnly":true,"type":"string"},"type":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"}}},"bigquery_v2_UndeleteDatasetRequest":{"description":"Request format for undeleting a dataset.","type":"object","properties":{"deletionTime":{"description":"Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. Undeleting a dataset using deletion time is not supported.","format":"google-datetime","type":"string"}}},"bigquery_v2_UserDefinedFunctionResource":{"description":" This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions","type":"object","properties":{"inlineCode":{"description":"[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.","type":"string"},"resourceUri":{"description":"[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).","type":"string"}}},"bigquery_v2_VectorSearchStatistics":{"description":"Statistics for a vector search query. Populated as part of JobStatistics2.","type":"object","properties":{"indexUnusedReasons":{"description":"When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IndexUnusedReason"}},"indexUsageMode":{"description":"Specifies the index usage mode for the query.","enum":["INDEX_USAGE_MODE_UNSPECIFIED","UNUSED","PARTIALLY_USED","FULLY_USED"],"type":"string"},"storedColumnsUsages":{"description":"Specifies the usage of stored columns in the query when stored columns are used in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StoredColumnsUsage"}}}},"bigquery_v2_ViewDefinition":{"description":"Describes the definition of a logical view.","type":"object","properties":{"foreignDefinitions":{"description":"Optional. Foreign view representations.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ForeignViewDefinition"}},"privacyPolicy":{"$ref":"#/components/schemas/bigquery_v2_PrivacyPolicy"},"query":{"description":"Required. A query that BigQuery executes when the view is referenced.","type":"string"},"useExplicitColumnNames":{"description":"True if the column names are explicitly specified. For example by using the 'CREATE VIEW v(c1, c2) AS ...' syntax. Can only be set for GoogleSQL views.","type":"boolean"},"useLegacySql":{"description":"Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). Queries and views that reference this view must use the same flag value. A wrapper is used here because the default value is True.","type":"boolean"},"userDefinedFunctionResources":{"description":"Describes user-defined function resources used in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_UserDefinedFunctionResource"}}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/bigquery":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/bigquery"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/bigquery/v2/rest","service":"bigquery","version":"v2"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"BigQuery API","version":"v2","description":"A data platform for customers to create, manage, share and query data."},"servers":[{"url":"https://bigquery.googleapis.com/bigquery/v2/"}],"paths":{"/projects":{"get":{"operationId":"bigquery.projects.list","x-executor-toolPath":"bigquery.projects.list","tags":["BigQuery API"],"description":"RPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the [Resource Manager](https://cloud.google.com/resource-manager/docs/) API, which provides the underlying data for this method and has more capabilities. # IAM Permissions Requires no specific IAM permission(s) to use this method. The results are filtered to only include projects on which the caller has been granted a project-level role such as a BigQuery predefined IAM role or a basic role such as Viewer or Owner.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"`maxResults` unset returns all results, up to 50 per page. Additionally, the number of projects in a page may be fewer than `maxResults` because projects are retrieved and then filtered to only projects with the BigQuery API enabled.","schema":{"description":"`maxResults` unset returns all results, up to 50 per page. Additionally, the number of projects in a page may be fewer than `maxResults` because projects are retrieved and then filtered to only projects with the BigQuery API enabled.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results. If not present, no further pages are present.","schema":{"description":"Page token, returned by a previous call, to request the next page of results. If not present, no further pages are present.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ProjectList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets":{"get":{"operationId":"bigquery.datasets.list","x-executor-toolPath":"bigquery.datasets.list","tags":["BigQuery API"],"description":"Lists all datasets in the specified project to which the user has been granted the READER dataset role. # IAM Permissions Requires no specific IAM permission(s) to use this method. Results are filtered to only include datasets on which the caller has the `bigquery.datasets.get` permission.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the datasets to be listed","schema":{"description":"Required. Project ID of the datasets to be listed","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"all","in":"query","required":false,"description":"Whether to list all datasets, including hidden ones","schema":{"description":"Whether to list all datasets, including hidden ones","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.","schema":{"description":"An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be AND-ed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results","schema":{"description":"Page token, returned by a previous call, to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_DatasetList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.datasets.insert","x-executor-toolPath":"bigquery.datasets.insert","tags":["BigQuery API"],"description":"Creates a new empty dataset. # IAM Permissions Requires the `bigquery.datasets.create` permission on the project.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the new dataset","schema":{"description":"Required. Project ID of the new dataset","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","schema":{"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Requests with conditional access policy binding in datasets must specify version 3. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}":{"get":{"operationId":"bigquery.datasets.get","x-executor-toolPath":"bigquery.datasets.get","tags":["BigQuery API"],"description":"Returns the dataset specified by datasetID. # IAM Permissions Requires the `bigquery.datasets.get` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested dataset","schema":{"description":"Required. Project ID of the requested dataset","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested dataset","schema":{"description":"Required. Dataset ID of the requested dataset","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to [IAM Policy version] (https://cloud.google.com/iam/docs/policies#versions) and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { \"access\": [ { \"role\": \"roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda\", \"userByEmail\": \"user@example.com\", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.","schema":{"description":"Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to [IAM Policy version] (https://cloud.google.com/iam/docs/policies#versions) and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { \"access\": [ { \"role\": \"roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda\", \"userByEmail\": \"user@example.com\", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"datasetView","in":"query","required":false,"description":"Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.","schema":{"description":"Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.","enum":["DATASET_VIEW_UNSPECIFIED","METADATA","ACL","FULL"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.datasets.update","x-executor-toolPath":"bigquery.datasets.update","tags":["BigQuery API"],"description":"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. # IAM Permissions Requires the `bigquery.datasets.update` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset being updated","schema":{"description":"Required. Project ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the dataset being updated","schema":{"description":"Required. Dataset ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","schema":{"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMode","in":"query","required":false,"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","schema":{"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","enum":["UPDATE_MODE_UNSPECIFIED","UPDATE_METADATA","UPDATE_ACL","UPDATE_FULL"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.datasets.delete","x-executor-toolPath":"bigquery.datasets.delete","tags":["BigQuery API"],"description":"Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. # IAM Permissions Requires the `bigquery.datasets.delete` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset being deleted","schema":{"description":"Required. Project ID of the dataset being deleted","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of dataset being deleted","schema":{"description":"Required. Dataset ID of dataset being deleted","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleteContents","in":"query","required":false,"description":"If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False","schema":{"description":"If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"patch":{"operationId":"bigquery.datasets.patch","x-executor-toolPath":"bigquery.datasets.patch","tags":["BigQuery API"],"description":"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.datasets.update` on the dataset. - `bigquery.datasets.get` on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset being updated","schema":{"description":"Required. Project ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the dataset being updated","schema":{"description":"Required. Dataset ID of the dataset being updated","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"accessPolicyVersion","in":"query","required":false,"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","schema":{"description":"Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMode","in":"query","required":false,"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","schema":{"description":"Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.","enum":["UPDATE_MODE_UNSPECIFIED","UPDATE_METADATA","UPDATE_ACL","UPDATE_FULL"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/models":{"get":{"operationId":"bigquery.models.list","x-executor-toolPath":"bigquery.models.list","tags":["BigQuery API"],"description":"Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method. # IAM Permissions Requires the `bigquery.models.list` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the models to list.","schema":{"description":"Required. Project ID of the models to list.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the models to list.","schema":{"description":"Required. Dataset ID of the models to list.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call to request the next page of results","schema":{"description":"Page token, returned by a previous call to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ListModelsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/models/{modelId}":{"get":{"operationId":"bigquery.models.get","x-executor-toolPath":"bigquery.models.get","tags":["BigQuery API"],"description":"Gets the specified model resource by model ID. # IAM Permissions Requires the `bigquery.models.getMetadata` permission on the model.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested model.","schema":{"description":"Required. Project ID of the requested model.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested model.","schema":{"description":"Required. Dataset ID of the requested model.","type":"string"},"allowReserved":true},{"name":"modelId","in":"path","required":true,"description":"Required. Model ID of the requested model.","schema":{"description":"Required. Model ID of the requested model.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Model"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.models.delete","x-executor-toolPath":"bigquery.models.delete","tags":["BigQuery API"],"description":"Deletes the model specified by modelId from the dataset. # IAM Permissions Requires the `bigquery.models.delete` permission on the model.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the model to delete.","schema":{"description":"Required. Project ID of the model to delete.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the model to delete.","schema":{"description":"Required. Dataset ID of the model to delete.","type":"string"},"allowReserved":true},{"name":"modelId","in":"path","required":true,"description":"Required. Model ID of the model to delete.","schema":{"description":"Required. Model ID of the model to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"patch":{"operationId":"bigquery.models.patch","x-executor-toolPath":"bigquery.models.patch","tags":["BigQuery API"],"description":"Patch specific fields in the specified model. # IAM Permissions Requires the `bigquery.models.updateMetadata` permission on the model.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the model to patch.","schema":{"description":"Required. Project ID of the model to patch.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the model to patch.","schema":{"description":"Required. Dataset ID of the model to patch.","type":"string"},"allowReserved":true},{"name":"modelId","in":"path","required":true,"description":"Required. Model ID of the model to patch.","schema":{"description":"Required. Model ID of the model to patch.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Model"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Model"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/routines":{"get":{"operationId":"bigquery.routines.list","x-executor-toolPath":"bigquery.routines.list","tags":["BigQuery API"],"description":"Lists all routines in the specified dataset. Requires the READER dataset role. # IAM Permissions Requires the `bigquery.routines.list` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the routines to list","schema":{"description":"Required. Project ID of the routines to list","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the routines to list","schema":{"description":"Required. Dataset ID of the routines to list","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"If set, then only the Routines matching this filter are returned. The supported format is `routineType:{RoutineType}`, where `{RoutineType}` is a RoutineType enum. For example: `routineType:SCALAR_FUNCTION`.","schema":{"description":"If set, then only the Routines matching this filter are returned. The supported format is `routineType:{RoutineType}`, where `{RoutineType}` is a RoutineType enum. For example: `routineType:SCALAR_FUNCTION`.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results","schema":{"description":"Page token, returned by a previous call, to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":false,"description":"If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.","schema":{"description":"If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ListRoutinesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.routines.insert","x-executor-toolPath":"bigquery.routines.insert","tags":["BigQuery API"],"description":"Creates a new routine in the dataset. # IAM Permissions Requires the `bigquery.routines.create` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the new routine","schema":{"description":"Required. Project ID of the new routine","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the new routine","schema":{"description":"Required. Dataset ID of the new routine","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/routines/{routineId}":{"get":{"operationId":"bigquery.routines.get","x-executor-toolPath":"bigquery.routines.get","tags":["BigQuery API"],"description":"Gets the specified routine resource by routine ID. # IAM Permissions Requires the `bigquery.routines.get` permission on the routine.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested routine","schema":{"description":"Required. Project ID of the requested routine","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested routine","schema":{"description":"Required. Dataset ID of the requested routine","type":"string"},"allowReserved":true},{"name":"routineId","in":"path","required":true,"description":"Required. Routine ID of the requested routine","schema":{"description":"Required. Routine ID of the requested routine","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":false,"description":"If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.","schema":{"description":"If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.routines.update","x-executor-toolPath":"bigquery.routines.update","tags":["BigQuery API"],"description":"Updates information in an existing routine. The update method replaces the entire Routine resource. # IAM Permissions Requires the `bigquery.routines.update` permission on the routine.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the routine to update","schema":{"description":"Required. Project ID of the routine to update","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the routine to update","schema":{"description":"Required. Dataset ID of the routine to update","type":"string"},"allowReserved":true},{"name":"routineId","in":"path","required":true,"description":"Required. Routine ID of the routine to update","schema":{"description":"Required. Routine ID of the routine to update","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.routines.delete","x-executor-toolPath":"bigquery.routines.delete","tags":["BigQuery API"],"description":"Deletes the routine specified by routineId from the dataset. # IAM Permissions Requires the `bigquery.routines.delete` permission on the routine.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the routine to delete","schema":{"description":"Required. Project ID of the routine to delete","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the routine to delete","schema":{"description":"Required. Dataset ID of the routine to delete","type":"string"},"allowReserved":true},{"name":"routineId","in":"path","required":true,"description":"Required. Routine ID of the routine to delete","schema":{"description":"Required. Routine ID of the routine to delete","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables":{"get":{"operationId":"bigquery.tables.list","x-executor-toolPath":"bigquery.tables.list","tags":["BigQuery API"],"description":"Lists all tables in the specified dataset. Requires the READER dataset role. # IAM Permissions Requires the `bigquery.tables.list` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the tables to list","schema":{"description":"Required. Project ID of the tables to list","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the tables to list","schema":{"description":"Required. Dataset ID of the tables to list","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results","schema":{"description":"Page token, returned by a previous call, to request the next page of results","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.tables.insert","x-executor-toolPath":"bigquery.tables.insert","tags":["BigQuery API"],"description":"Creates a new, empty table in the dataset. # IAM Permissions Requires the `bigquery.tables.create` permission on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the new table","schema":{"description":"Required. Project ID of the new table","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the new table","schema":{"description":"Required. Dataset ID of the new table","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}":{"get":{"operationId":"bigquery.tables.get","x-executor-toolPath":"bigquery.tables.get","tags":["BigQuery API"],"description":"Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. # IAM Permissions Requires the `bigquery.tables.get` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested table","schema":{"description":"Required. Project ID of the requested table","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the requested table","schema":{"description":"Required. Dataset ID of the requested table","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the requested table","schema":{"description":"Required. Table ID of the requested table","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"selectedFields","in":"query","required":false,"description":"List of table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed.","schema":{"description":"List of table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"view","in":"query","required":false,"description":"Optional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.","schema":{"description":"Optional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.","enum":["TABLE_METADATA_VIEW_UNSPECIFIED","BASIC","STORAGE_STATS","FULL"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.tables.update","x-executor-toolPath":"bigquery.tables.update","tags":["BigQuery API"],"description":"Updates information in an existing table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided in the submitted Table resource. # IAM Permissions Requires the `bigquery.tables.update` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to update","schema":{"description":"Required. Project ID of the table to update","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to update","schema":{"description":"Required. Dataset ID of the table to update","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to update","schema":{"description":"Required. Table ID of the table to update","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"autodetect_schema","in":"query","required":false,"description":"Optional. When true will autodetect schema, else will keep original schema","schema":{"description":"Optional. When true will autodetect schema, else will keep original schema","type":"boolean"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.tables.delete","x-executor-toolPath":"bigquery.tables.delete","tags":["BigQuery API"],"description":"Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. # IAM Permissions Requires the `bigquery.tables.delete` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to delete","schema":{"description":"Required. Project ID of the table to delete","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to delete","schema":{"description":"Required. Dataset ID of the table to delete","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to delete","schema":{"description":"Required. Table ID of the table to delete","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"patch":{"operationId":"bigquery.tables.patch","x-executor-toolPath":"bigquery.tables.patch","tags":["BigQuery API"],"description":"Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.tables.update` - `bigquery.tables.get`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to update","schema":{"description":"Required. Project ID of the table to update","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to update","schema":{"description":"Required. Dataset ID of the table to update","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to update","schema":{"description":"Required. Table ID of the table to update","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"autodetect_schema","in":"query","required":false,"description":"Optional. When true will autodetect schema, else will keep original schema","schema":{"description":"Optional. When true will autodetect schema, else will keep original schema","type":"boolean"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Table"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data":{"get":{"operationId":"bigquery.tabledata.list","x-executor-toolPath":"bigquery.tabledata.list","tags":["BigQuery API"],"description":"List the content of a table in rows. # IAM Permissions Requires the `bigquery.tables.getData` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project id of the table to list.","schema":{"description":"Required. Project id of the table to list.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset id of the table to list.","schema":{"description":"Required. Dataset id of the table to list.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table id of the table to list.","schema":{"description":"Required. Table id of the table to list.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"formatOptions.timestampOutputFormat","in":"query","required":false,"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","schema":{"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","enum":["TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED","FLOAT64","INT64","ISO8601_STRING"],"type":"string"},"style":"form","explode":false},{"name":"formatOptions.useInt64Timestamp","in":"query","required":false,"description":"Optional. Output timestamp as usec int64. Default is false.","schema":{"description":"Optional. Output timestamp as usec int64. Default is false.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Row limit of the table.","schema":{"description":"Row limit of the table.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"To retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list.","schema":{"description":"To retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"selectedFields","in":"query","required":false,"description":"Subset of fields to return, supports select into sub fields. Example: selected_fields = \"a,e.d.f\";","schema":{"description":"Subset of fields to return, supports select into sub fields. Example: selected_fields = \"a,e.d.f\";","type":"string"},"style":"form","explode":false},{"name":"startIndex","in":"query","required":false,"description":"Start row index of the table.","schema":{"description":"Start row index of the table.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableDataList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll":{"post":{"operationId":"bigquery.tabledata.insertAll","x-executor-toolPath":"bigquery.tabledata.insertAll","tags":["BigQuery API"],"description":"Streams data into BigQuery one record at a time without needing to run a load job. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.tables.updateData` on the table. - `bigquery.tables.get` on the table. - `bigquery.datasets.get` on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the destination.","schema":{"description":"Required. Project ID of the destination.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the destination.","schema":{"description":"Required. Dataset ID of the destination.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the destination.","schema":{"description":"Required. Table ID of the destination.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableDataInsertAllRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TableDataInsertAllResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/rowAccessPolicies":{"get":{"operationId":"bigquery.rowAccessPolicies.list","x-executor-toolPath":"bigquery.rowAccessPolicies.list","tags":["BigQuery API"],"description":"Lists all row access policies on the specified table. # IAM Permissions Requires the `bigquery.rowAccessPolicies.list` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the row access policies to list.","schema":{"description":"Required. Project ID of the row access policies to list.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of row access policies to list.","schema":{"description":"Required. Dataset ID of row access policies to list.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to list row access policies.","schema":{"description":"Required. Table ID of the table to list row access policies.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results.","schema":{"description":"Page token, returned by a previous call, to request the next page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_ListRowAccessPoliciesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.rowAccessPolicies.insert","x-executor-toolPath":"bigquery.rowAccessPolicies.insert","tags":["BigQuery API"],"description":"Creates a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.create` - `bigquery.rowAccessPolicies.setIamPolicy` - `bigquery.tables.getData`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to get the row access policy.","schema":{"description":"Required. Project ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to get the row access policy.","schema":{"description":"Required. Dataset ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to get the row access policy.","schema":{"description":"Required. Table ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/rowAccessPolicies/{policyId}":{"get":{"operationId":"bigquery.rowAccessPolicies.get","x-executor-toolPath":"bigquery.rowAccessPolicies.get","tags":["BigQuery API"],"description":"Gets the specified row access policy by policy ID. # IAM Permissions Requires the `bigquery.rowAccessPolicies.get` permission on the table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to get the row access policy.","schema":{"description":"Required. Project ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to get the row access policy.","schema":{"description":"Required. Dataset ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to get the row access policy.","schema":{"description":"Required. Table ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"policyId","in":"path","required":true,"description":"Required. Policy ID of the row access policy.","schema":{"description":"Required. Policy ID of the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"put":{"operationId":"bigquery.rowAccessPolicies.update","x-executor-toolPath":"bigquery.rowAccessPolicies.update","tags":["BigQuery API"],"description":"Updates a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.update` - `bigquery.rowAccessPolicies.setIamPolicy` - `bigquery.tables.getData`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to get the row access policy.","schema":{"description":"Required. Project ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to get the row access policy.","schema":{"description":"Required. Dataset ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to get the row access policy.","schema":{"description":"Required. Table ID of the table to get the row access policy.","type":"string"},"allowReserved":true},{"name":"policyId","in":"path","required":true,"description":"Required. Policy ID of the row access policy.","schema":{"description":"Required. Policy ID of the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"delete":{"operationId":"bigquery.rowAccessPolicies.delete","x-executor-toolPath":"bigquery.rowAccessPolicies.delete","tags":["BigQuery API"],"description":"Deletes a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.delete` - `bigquery.rowAccessPolicies.setIamPolicy`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to delete the row access policy.","schema":{"description":"Required. Project ID of the table to delete the row access policy.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to delete the row access policy.","schema":{"description":"Required. Dataset ID of the table to delete the row access policy.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to delete the row access policy.","schema":{"description":"Required. Table ID of the table to delete the row access policy.","type":"string"},"allowReserved":true},{"name":"policyId","in":"path","required":true,"description":"Required. Policy ID of the row access policy.","schema":{"description":"Required. Policy ID of the row access policy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"force","in":"query","required":false,"description":"If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.","schema":{"description":"If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/rowAccessPolicies:batchDelete":{"post":{"operationId":"bigquery.rowAccessPolicies.batchDelete","x-executor-toolPath":"bigquery.rowAccessPolicies.batchDelete","tags":["BigQuery API"],"description":"Deletes provided row access policies. # IAM Permissions Requires the following IAM permission(s) on the table: - `bigquery.rowAccessPolicies.delete` - `bigquery.rowAccessPolicies.setIamPolicy`","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the table to delete the row access policies.","schema":{"description":"Required. Project ID of the table to delete the row access policies.","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of the table to delete the row access policies.","schema":{"description":"Required. Dataset ID of the table to delete the row access policies.","type":"string"},"allowReserved":true},{"name":"tableId","in":"path","required":true,"description":"Required. Table ID of the table to delete the row access policies.","schema":{"description":"Required. Table ID of the table to delete the row access policies.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_BatchDeleteRowAccessPoliciesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/datasets/{datasetId}:undelete":{"post":{"operationId":"bigquery.datasets.undelete","x-executor-toolPath":"bigquery.datasets.undelete","tags":["BigQuery API"],"description":"Undeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.datasets.create` on the project. - `bigquery.datasets.get` on the dataset.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the dataset to be undeleted","schema":{"description":"Required. Project ID of the dataset to be undeleted","type":"string"},"allowReserved":true},{"name":"datasetId","in":"path","required":true,"description":"Required. Dataset ID of dataset being deleted","schema":{"description":"Required. Dataset ID of dataset being deleted","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_UndeleteDatasetRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Dataset"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs":{"get":{"operationId":"bigquery.jobs.list","x-executor-toolPath":"bigquery.jobs.list","tags":["BigQuery API"],"description":"Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. # IAM Permissions Requires no specific IAM permission(s) to use this method. Users are able to list the jobs they created. Additional access is granted based on the following permissions: - Users with the `bigquery.jobs.listAll` permission can list all jobs with all metadata. - Users with the `bigquery.jobs.list` permission can list all jobs, but with redacted information for jobs they did not create.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Project ID of the jobs to list.","schema":{"description":"Project ID of the jobs to list.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allUsers","in":"query","required":false,"description":"Whether to display jobs owned by all users in the project. Default False.","schema":{"description":"Whether to display jobs owned by all users in the project. Default False.","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxCreationTime","in":"query","required":false,"description":"Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.","schema":{"description":"Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","schema":{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"minCreationTime","in":"query","required":false,"description":"Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.","schema":{"description":"Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results.","schema":{"description":"Page token, returned by a previous call, to request the next page of results.","type":"string"},"style":"form","explode":false},{"name":"parentJobId","in":"query","required":false,"description":"If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.","schema":{"description":"If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"projection","in":"query","required":false,"description":"Restrict information returned to a set of selected fields","schema":{"description":"Restrict information returned to a set of selected fields","enum":["full","minimal"],"type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"stateFilter","in":"query","required":false,"description":"Filter for job state","schema":{"type":"array","items":{"description":"Filter for job state","enum":["done","pending","running"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_JobList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]},"post":{"operationId":"bigquery.jobs.insert","x-executor-toolPath":"bigquery.jobs.insert","tags":["BigQuery API"],"description":"Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts. # IAM Permissions Requires the `bigquery.jobs.create` permission on the project resource. Additional permissions are required depending on the job type: - **Load, Export, and Copy jobs**: Generally require data-level permissions such as `bigquery.tables.export` or access to external storage. - **Query jobs**: Permissions are dependent on the SQL statement. Complex queries (DDL, DCL) may require additional permissions to create reservations, modify IAM policies, or update project settings.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Project ID of project that will be billed for the job.","schema":{"description":"Project ID of project that will be billed for the job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs/{jobId}":{"get":{"operationId":"bigquery.jobs.get","x-executor-toolPath":"bigquery.jobs.get","tags":["BigQuery API"],"description":"Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. # IAM Permissions Requires the `bigquery.jobs.get` permission on the job resource. If the user matches the creator of the job, the `bigquery.jobs.create` permission on the project is required instead.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the requested job.","schema":{"description":"Required. Project ID of the requested job.","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the requested job.","schema":{"description":"Required. Job ID of the requested job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","schema":{"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs/{jobId}/cancel":{"post":{"operationId":"bigquery.jobs.cancel","x-executor-toolPath":"bigquery.jobs.cancel","tags":["BigQuery API"],"description":"Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. # IAM Permissions Requires the `bigquery.jobs.update` permission on the job resource. If the user matches the creator of the job, the `bigquery.jobs.create` permission on the project is required instead.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the job to cancel","schema":{"description":"Required. Project ID of the job to cancel","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the job to cancel","schema":{"description":"Required. Job ID of the job to cancel","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. You must [specify the location](https://cloud.google.com/bigquery/docs/locations#specify_locations) to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`)","schema":{"description":"The geographic location of the job. You must [specify the location](https://cloud.google.com/bigquery/docs/locations#specify_locations) to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`)","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_JobCancelResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/jobs/{jobId}/delete":{"delete":{"operationId":"bigquery.jobs.delete","x-executor-toolPath":"bigquery.jobs.delete","tags":["BigQuery API"],"description":"Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted. # IAM Permissions Requires the `bigquery.jobs.delete` permission on the job resource.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the job for which metadata is to be deleted.","schema":{"description":"Required. Project ID of the job for which metadata is to be deleted.","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed.","schema":{"description":"Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. Required. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","schema":{"description":"The geographic location of the job. Required. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/queries":{"post":{"operationId":"bigquery.jobs.query","x-executor-toolPath":"bigquery.jobs.query","tags":["BigQuery API"],"description":"Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. # IAM Permissions Requires the `bigquery.jobs.create` permission on the project resource. Data-level permissions are highly dependent on the SQL statement being executed. While standard queries require data access (such as `bigquery.tables.getData`), complex operations like DDL or DCL may require permissions to manage reservations, IAM policies, or project settings.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the query request.","schema":{"description":"Required. Project ID of the query request.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_QueryRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_QueryResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/queries/{jobId}":{"get":{"operationId":"bigquery.jobs.getQueryResults","x-executor-toolPath":"bigquery.jobs.getQueryResults","tags":["BigQuery API"],"description":"RPC to get the results of a query job. # IAM Permissions Requires the following IAM permission(s) to use this method: - `bigquery.jobs.get` on the job. - `bigquery.tables.getData` on the destination table. If the user matches the creator of the job, the following IAM permission(s) are required instead: - `bigquery.jobs.create` on the project. - `bigquery.tables.getData` on the destination table.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. Project ID of the query job.","schema":{"description":"Required. Project ID of the query job.","type":"string"},"allowReserved":true},{"name":"jobId","in":"path","required":true,"description":"Required. Job ID of the query job.","schema":{"description":"Required. Job ID of the query job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"formatOptions.timestampOutputFormat","in":"query","required":false,"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","schema":{"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","enum":["TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED","FLOAT64","INT64","ISO8601_STRING"],"type":"string"},"style":"form","explode":false},{"name":"formatOptions.useInt64Timestamp","in":"query","required":false,"description":"Optional. Output timestamp as usec int64. Default is false.","schema":{"description":"Optional. Output timestamp as usec int64. Default is false.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","schema":{"description":"The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of results to read.","schema":{"description":"Maximum number of results to read.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token, returned by a previous call, to request the next page of results.","schema":{"description":"Page token, returned by a previous call, to request the next page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startIndex","in":"query","required":false,"description":"Zero-based index of the starting row.","schema":{"description":"Zero-based index of the starting row.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"timeoutMs","in":"query","required":false,"description":"Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.","schema":{"description":"Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetQueryResultsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectId}/serviceAccount":{"get":{"operationId":"bigquery.projects.getServiceAccount","x-executor-toolPath":"bigquery.projects.getServiceAccount","tags":["BigQuery API"],"description":"RPC to get the service account for a project used for interactions with Google Cloud KMS. Requires the `bigquery.jobs.create` permission on the project resource. This permission is required to authorize the retrieval of the project's service identity for technical management tasks like encryption configuration.","parameters":[{"name":"projectId","in":"path","required":true,"description":"Required. ID of the project.","schema":{"description":"Required. ID of the project.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetServiceAccountResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}:getIamPolicy":{"post":{"operationId":"bigquery.routines.getIamPolicy","x-executor-toolPath":"bigquery.routines.getIamPolicy","tags":["BigQuery API"],"description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"routinesId","in":"path","required":true,"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}:setIamPolicy":{"post":{"operationId":"bigquery.routines.setIamPolicy","x-executor-toolPath":"bigquery.routines.setIamPolicy","tags":["BigQuery API"],"description":"Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"routinesId","in":"path","required":true,"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}:testIamPermissions":{"post":{"operationId":"bigquery.routines.testIamPermissions","x-executor-toolPath":"bigquery.routines.testIamPermissions","tags":["BigQuery API"],"description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"routinesId","in":"path","required":true,"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`routinesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:getIamPolicy":{"post":{"operationId":"bigquery.rowAccessPolicies.getIamPolicy","x-executor-toolPath":"bigquery.rowAccessPolicies.getIamPolicy","tags":["BigQuery API"],"description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"rowAccessPoliciesId","in":"path","required":true,"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}:testIamPermissions":{"post":{"operationId":"bigquery.rowAccessPolicies.testIamPermissions","x-executor-toolPath":"bigquery.rowAccessPolicies.testIamPermissions","tags":["BigQuery API"],"description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"rowAccessPoliciesId","in":"path","required":true,"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`rowAccessPoliciesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}/rowAccessPolicies/{rowAccessPoliciesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:getIamPolicy":{"post":{"operationId":"bigquery.tables.getIamPolicy","x-executor-toolPath":"bigquery.tables.getIamPolicy","tags":["BigQuery API"],"description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:setIamPolicy":{"post":{"operationId":"bigquery.tables.setIamPolicy","x-executor-toolPath":"bigquery.tables.setIamPolicy","tags":["BigQuery API"],"description":"Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}:testIamPermissions":{"post":{"operationId":"bigquery.tables.testIamPermissions","x-executor-toolPath":"bigquery.tables.testIamPermissions","tags":["BigQuery API"],"description":"Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"datasetsId","in":"path","required":true,"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`datasetsId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"tablesId","in":"path","required":true,"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tablesId` of `resource` (`projects/{projectsId}/datasets/{datasetsId}/tables/{tablesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"]}},"/upload/bigquery/v2/projects/{projectId}/jobs":{"post":{"operationId":"bigquery.jobs.insertMedia","x-executor-toolPath":"bigquery.jobs.insertMedia","tags":["BigQuery API"],"description":"Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts. # IAM Permissions Requires the `bigquery.jobs.create` permission on the project resource. Additional permissions are required depending on the job type: - **Load, Export, and Copy jobs**: Generally require data-level permissions such as `bigquery.tables.export` or access to external storage. - **Query jobs**: Permissions are dependent on the SQL statement. Complex queries (DDL, DCL) may require additional permissions to create reservations, modify IAM policies, or update project settings. (media upload)","parameters":[{"name":"projectId","in":"path","required":true,"description":"Project ID of project that will be billed for the job.","schema":{"description":"Project ID of project that will be billed for the job.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bigquery_v2_Job"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/bigquery"]}],"x-google-scopes":["https://www.googleapis.com/auth/bigquery"],"servers":[{"url":"https://bigquery.googleapis.com/"}]}}},"components":{"schemas":{"bigquery_v2_AggregateClassificationMetrics":{"description":"Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows.","type":"object","properties":{"accuracy":{"description":"Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.","format":"double","type":"number"},"f1Score":{"description":"The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"logLoss":{"description":"Logarithmic Loss. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"precision":{"description":"Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.","format":"double","type":"number"},"recall":{"description":"Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"rocAuc":{"description":"Area Under a ROC Curve. For multiclass this is a macro-averaged metric.","format":"double","type":"number"},"threshold":{"description":"Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classification models this is the confidence threshold.","format":"double","type":"number"}}},"bigquery_v2_AggregationThresholdPolicy":{"description":"Represents privacy policy associated with \"aggregation threshold\" method.","type":"object","properties":{"privacyUnitColumns":{"description":"Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation (\"outer.inner\")","type":"array","items":{"type":"string"}},"threshold":{"description":"Optional. The threshold for the \"aggregation threshold\" policy.","format":"int64","type":"string"}}},"bigquery_v2_Argument":{"description":"Input/output argument of a function or a stored procedure.","type":"object","properties":{"argumentKind":{"description":"Optional. Defaults to FIXED_TYPE.","enum":["ARGUMENT_KIND_UNSPECIFIED","FIXED_TYPE","ANY_TYPE","FIXED_TABLE","ANY_TABLE"],"type":"string"},"dataType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"isAggregate":{"description":"Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is equivalent to adding \"NOT AGGREGATE\" clause in DDL; Otherwise, it is equivalent to omitting \"NOT AGGREGATE\" clause in DDL.","type":"boolean"},"mode":{"description":"Optional. Specifies whether the argument is input or output. Can be set for procedures only.","enum":["MODE_UNSPECIFIED","IN","OUT","INOUT"],"type":"string"},"name":{"description":"Optional. The name of this argument. Can be absent for function return argument.","type":"string"},"tableType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlTableType"}}},"bigquery_v2_ArimaCoefficients":{"description":"Arima coefficients.","type":"object","properties":{"autoRegressiveCoefficients":{"description":"Auto-regressive coefficients, an array of double.","type":"array","items":{"format":"double","type":"number"}},"interceptCoefficient":{"description":"Intercept coefficient, just a double not an array.","format":"double","type":"number"},"movingAverageCoefficients":{"description":"Moving-average coefficients, an array of double.","type":"array","items":{"format":"double","type":"number"}}}},"bigquery_v2_ArimaFittingMetrics":{"description":"ARIMA model fitting metrics.","type":"object","properties":{"aic":{"description":"AIC.","format":"double","type":"number"},"logLikelihood":{"description":"Log-likelihood.","format":"double","type":"number"},"variance":{"description":"Variance.","format":"double","type":"number"}}},"bigquery_v2_ArimaForecastingMetrics":{"description":"Model evaluation metrics for ARIMA forecasting models.","type":"object","properties":{"arimaFittingMetrics":{"description":"Arima model fitting metrics.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaFittingMetrics"}},"arimaSingleModelForecastingMetrics":{"description":"Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaSingleModelForecastingMetrics"}},"hasDrift":{"description":"Whether Arima model fitted with drift or not. It is always false when d is not 1.","type":"array","items":{"type":"boolean"}},"nonSeasonalOrder":{"description":"Non-seasonal order.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"}},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}},"timeSeriesId":{"description":"Id to differentiate different time series for the large-scale case.","type":"array","items":{"type":"string"}}}},"bigquery_v2_ArimaModelInfo":{"description":"Arima model information.","type":"object","properties":{"arimaCoefficients":{"$ref":"#/components/schemas/bigquery_v2_ArimaCoefficients"},"arimaFittingMetrics":{"$ref":"#/components/schemas/bigquery_v2_ArimaFittingMetrics"},"hasDrift":{"description":"Whether Arima model fitted with drift or not. It is always false when d is not 1.","type":"boolean"},"hasHolidayEffect":{"description":"If true, holiday_effect is a part of time series decomposition result.","type":"boolean"},"hasSpikesAndDips":{"description":"If true, spikes_and_dips is a part of time series decomposition result.","type":"boolean"},"hasStepChanges":{"description":"If true, step_changes is a part of time series decomposition result.","type":"boolean"},"nonSeasonalOrder":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}},"timeSeriesId":{"description":"The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.","type":"string"},"timeSeriesIds":{"description":"The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.","type":"array","items":{"type":"string"}}}},"bigquery_v2_ArimaOrder":{"description":"Arima order, can be used for both non-seasonal and seasonal parts.","type":"object","properties":{"d":{"description":"Order of the differencing part.","format":"int64","type":"string"},"p":{"description":"Order of the autoregressive part.","format":"int64","type":"string"},"q":{"description":"Order of the moving-average part.","format":"int64","type":"string"}}},"bigquery_v2_ArimaResult":{"description":"(Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.","type":"object","properties":{"arimaModelInfo":{"description":"This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ArimaModelInfo"}},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}}}},"bigquery_v2_ArimaSingleModelForecastingMetrics":{"description":"Model evaluation metrics for a single ARIMA forecasting model.","type":"object","properties":{"arimaFittingMetrics":{"$ref":"#/components/schemas/bigquery_v2_ArimaFittingMetrics"},"hasDrift":{"description":"Is arima model fitted with drift or not. It is always false when d is not 1.","type":"boolean"},"hasHolidayEffect":{"description":"If true, holiday_effect is a part of time series decomposition result.","type":"boolean"},"hasSpikesAndDips":{"description":"If true, spikes_and_dips is a part of time series decomposition result.","type":"boolean"},"hasStepChanges":{"description":"If true, step_changes is a part of time series decomposition result.","type":"boolean"},"nonSeasonalOrder":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"},"seasonalPeriods":{"description":"Seasonal periods. Repeated because multiple periods are supported for one time series.","type":"array","items":{"enum":["SEASONAL_PERIOD_TYPE_UNSPECIFIED","NO_SEASONALITY","DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","HOURLY"],"type":"string"}},"timeSeriesId":{"description":"The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.","type":"string"},"timeSeriesIds":{"description":"The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.","type":"array","items":{"type":"string"}}}},"bigquery_v2_ArrowRecordBatch":{"description":"Arrow RecordBatch. This feature is not yet available.","type":"object","properties":{"serializedRecordBatch":{"description":"IPC-serialized Arrow RecordBatch.","format":"byte","type":"string"}}},"bigquery_v2_ArrowSchema":{"description":"Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available.","type":"object","properties":{"serializedSchema":{"description":"IPC serialized Arrow schema.","format":"byte","type":"string"}}},"bigquery_v2_ArrowSerializationOptions":{"description":"Contains options specific to Arrow Serialization. This feature is not yet available.","type":"object","properties":{"bufferCompression":{"description":"The compression codec to use for Arrow buffers in serialized record batches.","enum":["COMPRESSION_UNSPECIFIED","LZ4_FRAME","ZSTD"],"type":"string"},"picosTimestampPrecision":{"description":"Optional. Set timestamp precision option. If not set, the default precision is microseconds.","enum":["PICOS_TIMESTAMP_PRECISION_UNSPECIFIED","TIMESTAMP_PRECISION_MICROS","TIMESTAMP_PRECISION_NANOS","TIMESTAMP_PRECISION_PICOS"],"type":"string"}}},"bigquery_v2_AuditConfig":{"description":"Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.","type":"object","properties":{"auditLogConfigs":{"description":"The configuration for logging of each type of permission.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_AuditLogConfig"}},"service":{"description":"Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.","type":"string"}}},"bigquery_v2_AuditLogConfig":{"description":"Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.","type":"object","properties":{"exemptedMembers":{"description":"Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.","type":"array","items":{"type":"string"}},"logType":{"description":"The log type that this config enables.","enum":["LOG_TYPE_UNSPECIFIED","ADMIN_READ","DATA_WRITE","DATA_READ"],"type":"string"}}},"bigquery_v2_AvroOptions":{"description":"Options for external data sources.","type":"object","properties":{"useAvroLogicalTypes":{"description":"Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).","type":"boolean"}}},"bigquery_v2_BatchDeleteRowAccessPoliciesRequest":{"description":"Request message for the BatchDeleteRowAccessPoliciesRequest method.","type":"object","properties":{"force":{"description":"If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.","type":"boolean"},"policyIds":{"description":"Required. Policy IDs of the row access policies.","type":"array","items":{"type":"string"}}}},"bigquery_v2_BiEngineReason":{"description":"Reason why BI Engine didn't accelerate the query (or sub-query).","type":"object","properties":{"code":{"description":"Output only. High-level BI Engine reason for partial or disabled acceleration","readOnly":true,"enum":["CODE_UNSPECIFIED","NO_RESERVATION","INSUFFICIENT_RESERVATION","UNSUPPORTED_SQL_TEXT","INPUT_TOO_LARGE","OTHER_REASON","TABLE_EXCLUDED"],"type":"string"},"message":{"description":"Output only. Free form human-readable reason for partial or disabled acceleration.","readOnly":true,"type":"string"}}},"bigquery_v2_BiEngineStatistics":{"description":"Statistics for a BI Engine specific query. Populated as part of JobStatistics2","type":"object","properties":{"accelerationMode":{"description":"Output only. Specifies which mode of BI Engine acceleration was performed (if any).","readOnly":true,"enum":["BI_ENGINE_ACCELERATION_MODE_UNSPECIFIED","BI_ENGINE_DISABLED","PARTIAL_INPUT","FULL_INPUT","FULL_QUERY"],"type":"string"},"biEngineMode":{"description":"Output only. Specifies which mode of BI Engine acceleration was performed (if any).","readOnly":true,"enum":["ACCELERATION_MODE_UNSPECIFIED","DISABLED","PARTIAL","FULL"],"type":"string"},"biEngineReasons":{"description":"In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BiEngineReason"}}}},"bigquery_v2_BigLakeConfiguration":{"description":"Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.)","type":"object","properties":{"connectionId":{"description":"Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}\".","type":"string"},"fileFormat":{"description":"Optional. The file format the table data is stored in.","enum":["FILE_FORMAT_UNSPECIFIED","PARQUET"],"type":"string"},"storageUri":{"description":"Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/`","type":"string"},"tableFormat":{"description":"Optional. The table format the metadata only snapshots are stored in.","enum":["TABLE_FORMAT_UNSPECIFIED","ICEBERG"],"type":"string"}}},"bigquery_v2_BigQueryModelTraining":{"type":"object","properties":{"currentIteration":{"description":"Deprecated.","format":"int32","type":"integer"},"expectedTotalIterations":{"description":"Deprecated.","format":"int64","type":"string"}}},"bigquery_v2_BigtableColumn":{"description":"Information related to a Bigtable column.","type":"object","properties":{"encoding":{"description":"Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. PROTO_BINARY - indicates values are encoded using serialized proto messages. This can only be used in combination with JSON type. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.","type":"string"},"fieldName":{"description":"Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries.","type":"string"},"onlyReadLatest":{"description":"Optional. If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.","type":"boolean"},"protoConfig":{"$ref":"#/components/schemas/bigquery_v2_BigtableProtoConfig"},"qualifierEncoded":{"description":"[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.","format":"byte","type":"string"},"qualifierString":{"description":"Qualifier string.","type":"string"},"type":{"description":"Optional. The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.","type":"string"}}},"bigquery_v2_BigtableColumnFamily":{"description":"Information related to a Bigtable column family.","type":"object","properties":{"columns":{"description":"Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BigtableColumn"}},"encoding":{"description":"Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. PROTO_BINARY - indicates values are encoded using serialized proto messages. This can only be used in combination with JSON type. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.","type":"string"},"familyId":{"description":"Identifier of the column family.","type":"string"},"onlyReadLatest":{"description":"Optional. If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.","type":"boolean"},"protoConfig":{"$ref":"#/components/schemas/bigquery_v2_BigtableProtoConfig"},"type":{"description":"Optional. The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN * JSON Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.","type":"string"}}},"bigquery_v2_BigtableOptions":{"description":"Options specific to Google Cloud Bigtable data sources.","type":"object","properties":{"columnFamilies":{"description":"Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BigtableColumnFamily"}},"ignoreUnspecifiedColumnFamilies":{"description":"Optional. If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.","type":"boolean"},"outputColumnFamiliesAsJson":{"description":"Optional. If field is true, then each column family will be read as a single JSON column. Otherwise they are read as a repeated cell structure containing timestamp/value tuples. The default value is false.","type":"boolean"},"readRowkeyAsString":{"description":"Optional. If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.","type":"boolean"}}},"bigquery_v2_BigtableProtoConfig":{"description":"Information related to a Bigtable protobuf column.","type":"object","properties":{"protoMessageName":{"description":"Optional. The fully qualified proto message name of the protobuf. In the format of \"foo.bar.Message\".","type":"string"},"schemaBundleId":{"description":"Optional. The ID of the Bigtable SchemaBundle resource associated with this protobuf. The ID should be referred to within the parent table, e.g., `foo` rather than `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/foo`. See [more details on Bigtable SchemaBundles](https://docs.cloud.google.com/bigtable/docs/create-manage-protobuf-schemas).","type":"string"}}},"bigquery_v2_BinaryClassificationMetrics":{"description":"Evaluation metrics for binary classification/classifier models.","type":"object","properties":{"aggregateClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_AggregateClassificationMetrics"},"binaryConfusionMatrixList":{"description":"Binary confusion matrix at multiple thresholds.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BinaryConfusionMatrix"}},"negativeLabel":{"description":"Label representing the negative class.","type":"string"},"positiveLabel":{"description":"Label representing the positive class.","type":"string"}}},"bigquery_v2_BinaryConfusionMatrix":{"description":"Confusion matrix for binary classification models.","type":"object","properties":{"accuracy":{"description":"The fraction of predictions given the correct label.","format":"double","type":"number"},"f1Score":{"description":"The equally weighted average of recall and precision.","format":"double","type":"number"},"falseNegatives":{"description":"Number of false samples predicted as false.","format":"int64","type":"string"},"falsePositives":{"description":"Number of false samples predicted as true.","format":"int64","type":"string"},"positiveClassThreshold":{"description":"Threshold value used when computing each of the following metric.","format":"double","type":"number"},"precision":{"description":"The fraction of actual positive predictions that had positive actual labels.","format":"double","type":"number"},"recall":{"description":"The fraction of actual positive labels that were given a positive prediction.","format":"double","type":"number"},"trueNegatives":{"description":"Number of true samples predicted as false.","format":"int64","type":"string"},"truePositives":{"description":"Number of true samples predicted as true.","format":"int64","type":"string"}}},"bigquery_v2_Binding":{"description":"Associates `members`, or principals, with a `role`.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/bigquery_v2_Expr"},"members":{"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.","type":"array","items":{"type":"string"}},"role":{"description":"Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).","type":"string"}}},"bigquery_v2_BqmlIterationResult":{"type":"object","properties":{"durationMs":{"description":"Deprecated.","format":"int64","type":"string"},"evalLoss":{"description":"Deprecated.","format":"double","type":"number"},"index":{"description":"Deprecated.","format":"int32","type":"integer"},"learnRate":{"description":"Deprecated.","format":"double","type":"number"},"trainingLoss":{"description":"Deprecated.","format":"double","type":"number"}}},"bigquery_v2_BqmlTrainingRun":{"type":"object","properties":{"iterationResults":{"description":"Deprecated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BqmlIterationResult"}},"startTime":{"description":"Deprecated.","format":"date-time","type":"string"},"state":{"description":"Deprecated.","type":"string"},"trainingOptions":{"description":"Deprecated.","type":"object","properties":{"earlyStop":{"type":"boolean"},"l1Reg":{"format":"double","type":"number"},"l2Reg":{"format":"double","type":"number"},"learnRate":{"format":"double","type":"number"},"learnRateStrategy":{"type":"string"},"lineSearchInitLearnRate":{"format":"double","type":"number"},"maxIteration":{"format":"int64","type":"string"},"minRelProgress":{"format":"double","type":"number"},"warmStart":{"type":"boolean"}}}}},"bigquery_v2_CategoricalValue":{"description":"Representative value of a categorical feature.","type":"object","properties":{"categoryCounts":{"description":"Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category \"_OTHER_\" and count as aggregate counts of remaining categories.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_CategoryCount"}}}},"bigquery_v2_CategoryCount":{"description":"Represents the count of a single category within the cluster.","type":"object","properties":{"category":{"description":"The name of category.","type":"string"},"count":{"description":"The count of training samples matching the category within the cluster.","format":"int64","type":"string"}}},"bigquery_v2_CloneDefinition":{"description":"Information about base table and clone time of a table clone.","type":"object","properties":{"baseTableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"cloneTime":{"description":"Required. The time at which the base table was cloned. This value is reported in the JSON response using RFC3339 format.","format":"date-time","type":"string"}}},"bigquery_v2_Cluster":{"description":"Message containing the information about one cluster.","type":"object","properties":{"centroidId":{"description":"Centroid id.","format":"int64","type":"string"},"count":{"description":"Count of training data rows that were assigned to this cluster.","format":"int64","type":"string"},"featureValues":{"description":"Values of highly variant features for this cluster.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_FeatureValue"}}}},"bigquery_v2_ClusterInfo":{"description":"Information about a single cluster for clustering model.","type":"object","properties":{"centroidId":{"description":"Centroid id.","format":"int64","type":"string"},"clusterRadius":{"description":"Cluster radius, the average distance from centroid to each point assigned to the cluster.","format":"double","type":"number"},"clusterSize":{"description":"Cluster size, the total number of points assigned to the cluster.","format":"int64","type":"string"}}},"bigquery_v2_Clustering":{"description":"Configures table clustering.","type":"object","properties":{"fields":{"description":"One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations).","type":"array","items":{"type":"string"}}}},"bigquery_v2_ClusteringMetrics":{"description":"Evaluation metrics for clustering models.","type":"object","properties":{"clusters":{"description":"Information for all clusters.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Cluster"}},"daviesBouldinIndex":{"description":"Davies-Bouldin index.","format":"double","type":"number"},"meanSquaredDistance":{"description":"Mean of squared distances between each sample to its cluster centroid.","format":"double","type":"number"}}},"bigquery_v2_ConfusionMatrix":{"description":"Confusion matrix for multi-class classification models.","type":"object","properties":{"confidenceThreshold":{"description":"Confidence threshold used when computing the entries of the confusion matrix.","format":"double","type":"number"},"rows":{"description":"One row per actual label.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Row"}}}},"bigquery_v2_ConnectionProperty":{"description":"A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration * **service_account**: indicates the service account to use to run a continuous query. If set, the query job uses the service account to access Google Cloud resources. Service account access is bounded by the IAM permissions that you have granted to the service account. Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.","type":"object","properties":{"key":{"description":"The key of the property to set.","type":"string"},"value":{"description":"The value of the property to set.","type":"string"}}},"bigquery_v2_CsvOptions":{"description":"Information related to a CSV data source.","type":"object","properties":{"allowJaggedRows":{"description":"Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.","type":"boolean"},"allowQuotedNewlines":{"description":"Optional. Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.","type":"boolean"},"encoding":{"description":"Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.","type":"string"},"fieldDelimiter":{"description":"Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence \"\\t\" (U+0009) to specify a tab separator. The default value is comma (\",\", U+002C).","type":"string"},"nullMarker":{"description":"Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.","type":"string"},"nullMarkers":{"description":"Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.","type":"array","items":{"type":"string"}},"preserveAsciiControlCharacters":{"description":"Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\\x00' to '\\x1F') are preserved.","type":"boolean"},"quote":{"description":"Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (\"). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' \" ', use ' \"\" '.","default":"\"","type":"string"},"skipLeadingRows":{"description":"Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.","format":"int64","type":"string"},"sourceColumnMatch":{"description":"Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. Acceptable values are: POSITION - matches by position. This assumes that the columns are ordered the same way as the schema. NAME - matches by name. This reads the header row as column names and reorders columns to match the field names in the schema.","type":"string"}}},"bigquery_v2_DataFormatOptions":{"description":"Options for data format adjustments.","type":"object","properties":{"timestampOutputFormat":{"description":"Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing `use_int64_timestamp` option.","enum":["TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED","FLOAT64","INT64","ISO8601_STRING"],"type":"string"},"useInt64Timestamp":{"description":"Optional. Output timestamp as usec int64. Default is false.","type":"boolean"}}},"bigquery_v2_DataMaskingStatistics":{"description":"Statistics for data-masking.","type":"object","properties":{"dataMaskingApplied":{"description":"Whether any accessed data was protected by the data masking.","type":"boolean"}}},"bigquery_v2_DataPolicyList":{"description":"A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).","type":"object","properties":{"dataPolicies":{"description":"Contains a list of data policy options. At most 9 data policies are allowed per field.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_DataPolicyOption"}}}},"bigquery_v2_DataPolicyOption":{"description":"Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).","type":"object","properties":{"name":{"description":"Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.","type":"string"}}},"bigquery_v2_DataSplitResult":{"description":"Data split result. This contains references to the training and evaluation data tables that were used to train the model.","type":"object","properties":{"evaluationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"testTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"trainingTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_Dataset":{"description":"Represents a BigQuery dataset.","type":"object","properties":{"access":{"description":"Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.","type":"array","items":{"description":"An object that defines dataset access for an entity.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/bigquery_v2_Expr"},"dataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetAccessEntry"},"domain":{"description":"[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\". Maps to IAM policy member \"domain:DOMAIN\".","type":"string"},"groupByEmail":{"description":"[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member \"group:GROUP\".","type":"string"},"iamMember":{"description":"[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.","type":"string"},"role":{"description":"An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".","type":"string"},"routine":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"},"specialGroup":{"description":"[Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.","type":"string"},"userByEmail":{"description":"[Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member \"user:EMAIL\" or \"serviceAccount:EMAIL\".","type":"string"},"view":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}}},"catalogSource":{"description":"Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake","readOnly":true,"type":"string"},"creationTime":{"description":"Output only. The time when this dataset was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"datasetReference":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"defaultCollation":{"description":"Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.","type":"string"},"defaultEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"defaultPartitionExpirationMs":{"description":"This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the `TimePartitioning.expirationMs` property on the new table. If you set `TimePartitioning.expirationMs` explicitly when creating a table, the `defaultPartitionExpirationMs` of the containing dataset is ignored. When creating a partitioned table, if `defaultPartitionExpirationMs` is set, the `defaultTableExpirationMs` value is ignored and the table will not be inherit a table expiration deadline.","format":"int64","type":"string"},"defaultRoundingMode":{"description":"Optional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table's default rounding mode, unless otherwise specified.","enum":["ROUNDING_MODE_UNSPECIFIED","ROUND_HALF_AWAY_FROM_ZERO","ROUND_HALF_EVEN"],"type":"string"},"defaultTableExpirationMs":{"description":"Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.","format":"int64","type":"string"},"description":{"description":"Optional. A user-friendly description of the dataset.","type":"string"},"etag":{"description":"Output only. A hash of the resource.","readOnly":true,"type":"string"},"externalCatalogDatasetOptions":{"$ref":"#/components/schemas/bigquery_v2_ExternalCatalogDatasetOptions"},"externalDatasetReference":{"$ref":"#/components/schemas/bigquery_v2_ExternalDatasetReference"},"friendlyName":{"description":"Optional. A descriptive name for the dataset.","type":"string"},"id":{"description":"Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.","readOnly":true,"type":"string"},"isCaseInsensitive":{"description":"Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.","type":"boolean"},"kind":{"description":"Output only. The resource type.","readOnly":true,"default":"bigquery#dataset","type":"string"},"labels":{"description":"The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See [Creating and Updating Dataset Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) for more information.","type":"object","additionalProperties":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The date when this dataset was last modified, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"linkedDatasetMetadata":{"$ref":"#/components/schemas/bigquery_v2_LinkedDatasetMetadata"},"linkedDatasetSource":{"$ref":"#/components/schemas/bigquery_v2_LinkedDatasetSource"},"location":{"description":"The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.","type":"string"},"maxTimeTravelHours":{"description":"Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.","format":"int64","type":"string"},"resourceTags":{"description":"Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"123456789012/environment\" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"Production\". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details.","type":"object","additionalProperties":{"type":"string"}},"restrictions":{"$ref":"#/components/schemas/bigquery_v2_RestrictionConfig"},"satisfiesPzi":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"satisfiesPzs":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"selfLink":{"description":"Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.","readOnly":true,"type":"string"},"storageBillingModel":{"description":"Optional. Updates storage_billing_model for the dataset.","enum":["STORAGE_BILLING_MODEL_UNSPECIFIED","LOGICAL","PHYSICAL"],"type":"string"},"tags":{"description":"Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.","readOnly":true,"type":"array","items":{"description":"A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions","type":"object","properties":{"tagKey":{"description":"Required. The namespaced friendly name of the tag key, e.g. \"12345/environment\" where 12345 is org id.","type":"string"},"tagValue":{"description":"Required. The friendly short name of the tag value, e.g. \"production\".","type":"string"}}}},"type":{"description":"Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API.","readOnly":true,"type":"string"}}},"bigquery_v2_DatasetAccessEntry":{"description":"Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset.","type":"object","properties":{"dataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"targetTypes":{"description":"Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future.","type":"array","items":{"enum":["TARGET_TYPE_UNSPECIFIED","VIEWS","ROUTINES"],"type":"string"}}}},"bigquery_v2_DatasetList":{"description":"Response format for a page of results when listing datasets.","type":"object","properties":{"datasets":{"description":"An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.","type":"array","items":{"description":"A dataset resource with only a subset of fields, to be returned in a list of datasets.","type":"object","properties":{"catalogSource":{"description":"Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset. * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake.","readOnly":true,"type":"string"},"datasetReference":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"externalDatasetReference":{"$ref":"#/components/schemas/bigquery_v2_ExternalDatasetReference"},"friendlyName":{"description":"An alternate name for the dataset. The friendly name is purely decorative in nature.","type":"string"},"id":{"description":"The fully-qualified, unique, opaque ID of the dataset.","type":"string"},"kind":{"description":"The resource type. This property always returns the value \"bigquery#dataset\"","type":"string"},"labels":{"description":"The labels associated with this dataset. You can use these to organize and group your datasets.","type":"object","additionalProperties":{"type":"string"}},"location":{"description":"The geographic location where the dataset resides.","type":"string"},"type":{"description":"Output only. Same as `type` in `Dataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API.","readOnly":true,"type":"string"}}}},"etag":{"description":"Output only. A hash value of the results page. You can use this property to determine if the page has changed since the last request.","readOnly":true,"type":"string"},"kind":{"description":"Output only. The resource type. This property always returns the value \"bigquery#datasetList\"","readOnly":true,"default":"bigquery#datasetList","type":"string"},"nextPageToken":{"description":"A token that can be used to request the next results page. This property is omitted on the final results page.","type":"string"},"unreachable":{"description":"A list of skipped locations that were unreachable. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations. Example: \"europe-west5\"","type":"array","items":{"type":"string"}}}},"bigquery_v2_DatasetReference":{"description":"Identifier for a dataset.","type":"object","properties":{"datasetId":{"description":"Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.","type":"string"},"projectId":{"description":"Optional. The ID of the project containing this dataset.","type":"string"}}},"bigquery_v2_DestinationTableProperties":{"description":"Properties for the destination table.","type":"object","properties":{"description":{"description":"Optional. The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.","type":"string"},"expirationTime":{"description":"Internal use only.","format":"date-time","type":"string"},"friendlyName":{"description":"Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name.","type":"string"},"labels":{"description":"Optional. The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.","type":"object","additionalProperties":{"type":"string"}}}},"bigquery_v2_DifferentialPrivacyPolicy":{"description":"Represents privacy policy associated with \"differential privacy\" method.","type":"object","properties":{"deltaBudget":{"description":"Optional. The total delta budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of delta that is pre-defined by the contributor through the privacy policy delta_per_query field. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.","format":"double","type":"number"},"deltaBudgetRemaining":{"description":"Output only. The delta budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.","format":"double","readOnly":true,"type":"number"},"deltaPerQuery":{"description":"Optional. The delta value that is used per query. Delta represents the probability that any row will fail to be epsilon differentially private. Indicates the risk associated with exposing aggregate rows in the result of a query.","format":"double","type":"number"},"epsilonBudget":{"description":"Optional. The total epsilon budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of epsilon they request in their query. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.","format":"double","type":"number"},"epsilonBudgetRemaining":{"description":"Output only. The epsilon budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.","format":"double","readOnly":true,"type":"number"},"maxEpsilonPerQuery":{"description":"Optional. The maximum epsilon value that a query can consume. If the subscriber specifies epsilon as a parameter in a SELECT query, it must be less than or equal to this value. The epsilon parameter controls the amount of noise that is added to the groups — a higher epsilon means less noise.","format":"double","type":"number"},"maxGroupsContributed":{"description":"Optional. The maximum groups contributed value that is used per query. Represents the maximum number of groups to which each protected entity can contribute. Changing this value does not improve or worsen privacy. The best value for accuracy and utility depends on the query and data.","format":"int64","type":"string"},"privacyUnitColumn":{"description":"Optional. The privacy unit column associated with this policy. Differential privacy policies can only have one privacy unit column per data source object (table, view).","type":"string"}}},"bigquery_v2_DimensionalityReductionMetrics":{"description":"Model evaluation metrics for dimensionality reduction models.","type":"object","properties":{"totalExplainedVarianceRatio":{"description":"Total percentage of variance explained by the selected principal components.","format":"double","type":"number"}}},"bigquery_v2_DmlStatistics":{"description":"Detailed statistics for DML statements","type":"object","properties":{"deletedRowCount":{"description":"Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.","format":"int64","readOnly":true,"type":"string"},"dmlMode":{"description":"Output only. DML mode used.","readOnly":true,"enum":["DML_MODE_UNSPECIFIED","COARSE_GRAINED_DML","FINE_GRAINED_DML"],"type":"string"},"fineGrainedDmlUnusedReason":{"description":"Output only. Reason for disabling fine-grained DML if applicable.","readOnly":true,"enum":["FINE_GRAINED_DML_UNUSED_REASON_UNSPECIFIED","MAX_PARTITION_SIZE_EXCEEDED","TABLE_NOT_ENROLLED","DML_IN_MULTI_STATEMENT_TRANSACTION"],"type":"string"},"insertedRowCount":{"description":"Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements","format":"int64","readOnly":true,"type":"string"},"updatedRowCount":{"description":"Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_DoubleCandidates":{"description":"Discrete candidates of a double hyperparameter.","type":"object","properties":{"candidates":{"description":"Candidates for the double parameter in increasing order.","type":"array","items":{"format":"double","type":"number"}}}},"bigquery_v2_DoubleHparamSearchSpace":{"description":"Search space for a double hyperparameter.","type":"object","properties":{"candidates":{"$ref":"#/components/schemas/bigquery_v2_DoubleCandidates"},"range":{"$ref":"#/components/schemas/bigquery_v2_DoubleRange"}}},"bigquery_v2_DoubleRange":{"description":"Range of a double hyperparameter.","type":"object","properties":{"max":{"description":"Max value of the double parameter.","format":"double","type":"number"},"min":{"description":"Min value of the double parameter.","format":"double","type":"number"}}},"bigquery_v2_EncryptionConfiguration":{"description":"Configuration for Cloud KMS encryption settings.","type":"object","properties":{"kmsKeyName":{"description":"Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.","type":"string"}}},"bigquery_v2_Entry":{"description":"A single entry in the confusion matrix.","type":"object","properties":{"itemCount":{"description":"Number of items being predicted as this label.","format":"int64","type":"string"},"predictedLabel":{"description":"The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.","type":"string"}}},"bigquery_v2_ErrorProto":{"description":"Error details.","type":"object","properties":{"debugInfo":{"description":"Debugging information. This property is internal to Google and should not be used.","type":"string"},"location":{"description":"Specifies where the error occurred, if present.","type":"string"},"message":{"description":"A human-readable description of the error.","type":"string"},"reason":{"description":"A short error code that summarizes the error.","type":"string"}}},"bigquery_v2_EvaluationMetrics":{"description":"Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.","type":"object","properties":{"arimaForecastingMetrics":{"$ref":"#/components/schemas/bigquery_v2_ArimaForecastingMetrics"},"binaryClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_BinaryClassificationMetrics"},"clusteringMetrics":{"$ref":"#/components/schemas/bigquery_v2_ClusteringMetrics"},"dimensionalityReductionMetrics":{"$ref":"#/components/schemas/bigquery_v2_DimensionalityReductionMetrics"},"multiClassClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_MultiClassClassificationMetrics"},"rankingMetrics":{"$ref":"#/components/schemas/bigquery_v2_RankingMetrics"},"regressionMetrics":{"$ref":"#/components/schemas/bigquery_v2_RegressionMetrics"}}},"bigquery_v2_ExplainQueryStage":{"description":"A single stage of query execution.","type":"object","properties":{"completedParallelInputs":{"description":"Number of parallel input segments completed.","format":"int64","type":"string"},"computeMode":{"description":"Output only. Compute mode for this stage.","readOnly":true,"enum":["COMPUTE_MODE_UNSPECIFIED","BIGQUERY","BI_ENGINE"],"type":"string"},"computeMsAvg":{"description":"Milliseconds the average shard spent on CPU-bound tasks.","format":"int64","type":"string"},"computeMsMax":{"description":"Milliseconds the slowest shard spent on CPU-bound tasks.","format":"int64","type":"string"},"computeRatioAvg":{"description":"Relative amount of time the average shard spent on CPU-bound tasks.","format":"double","type":"number"},"computeRatioMax":{"description":"Relative amount of time the slowest shard spent on CPU-bound tasks.","format":"double","type":"number"},"endMs":{"description":"Stage end time represented as milliseconds since the epoch.","format":"int64","type":"string"},"id":{"description":"Unique ID for the stage within the plan.","format":"int64","type":"string"},"inputStages":{"description":"IDs for stages that are inputs to this stage.","type":"array","items":{"format":"int64","type":"string"}},"name":{"description":"Human-readable name for the stage.","type":"string"},"parallelInputs":{"description":"Number of parallel input segments to be processed","format":"int64","type":"string"},"readMsAvg":{"description":"Milliseconds the average shard spent reading input.","format":"int64","type":"string"},"readMsMax":{"description":"Milliseconds the slowest shard spent reading input.","format":"int64","type":"string"},"readRatioAvg":{"description":"Relative amount of time the average shard spent reading input.","format":"double","type":"number"},"readRatioMax":{"description":"Relative amount of time the slowest shard spent reading input.","format":"double","type":"number"},"recordsRead":{"description":"Number of records read into the stage.","format":"int64","type":"string"},"recordsWritten":{"description":"Number of records written by the stage.","format":"int64","type":"string"},"shuffleOutputBytes":{"description":"Total number of bytes written to shuffle.","format":"int64","type":"string"},"shuffleOutputBytesSpilled":{"description":"Total number of bytes written to shuffle and spilled to disk.","format":"int64","type":"string"},"slotMs":{"description":"Slot-milliseconds used by the stage.","format":"int64","type":"string"},"startMs":{"description":"Stage start time represented as milliseconds since the epoch.","format":"int64","type":"string"},"status":{"description":"Current status for this stage.","type":"string"},"steps":{"description":"List of operations within the stage in dependency order (approximately chronological).","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExplainQueryStep"}},"waitMsAvg":{"description":"Milliseconds the average shard spent waiting to be scheduled.","format":"int64","type":"string"},"waitMsMax":{"description":"Milliseconds the slowest shard spent waiting to be scheduled.","format":"int64","type":"string"},"waitRatioAvg":{"description":"Relative amount of time the average shard spent waiting to be scheduled.","format":"double","type":"number"},"waitRatioMax":{"description":"Relative amount of time the slowest shard spent waiting to be scheduled.","format":"double","type":"number"},"writeMsAvg":{"description":"Milliseconds the average shard spent on writing output.","format":"int64","type":"string"},"writeMsMax":{"description":"Milliseconds the slowest shard spent on writing output.","format":"int64","type":"string"},"writeRatioAvg":{"description":"Relative amount of time the average shard spent on writing output.","format":"double","type":"number"},"writeRatioMax":{"description":"Relative amount of time the slowest shard spent on writing output.","format":"double","type":"number"}}},"bigquery_v2_ExplainQueryStep":{"description":"An operation within a stage.","type":"object","properties":{"kind":{"description":"Machine-readable operation type.","type":"string"},"substeps":{"description":"Human-readable description of the step(s).","type":"array","items":{"type":"string"}}}},"bigquery_v2_Explanation":{"description":"Explanation for a single feature.","type":"object","properties":{"attribution":{"description":"Attribution of feature.","format":"double","type":"number"},"featureName":{"description":"The full feature name. For non-numerical features, will be formatted like `.`. Overall size of feature name will always be truncated to first 120 characters.","type":"string"}}},"bigquery_v2_ExportDataStatistics":{"description":"Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4.","type":"object","properties":{"fileCount":{"description":"Number of destination files generated in case of EXPORT DATA statement only.","format":"int64","type":"string"},"rowCount":{"description":"[Alpha] Number of destination rows generated in case of EXPORT DATA statement only.","format":"int64","type":"string"}}},"bigquery_v2_Expr":{"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.","type":"object","properties":{"description":{"description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.","type":"string"},"expression":{"description":"Textual representation of an expression in Common Expression Language syntax.","type":"string"},"location":{"description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.","type":"string"},"title":{"description":"Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.","type":"string"}}},"bigquery_v2_ExternalCatalogDatasetOptions":{"description":"Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema, or namespace represented by the current dataset.","type":"object","properties":{"defaultStorageLocationUri":{"description":"Optional. The storage location URI for all tables in the dataset. Equivalent to hive metastore's database locationUri. Maximum length of 1024 characters.","type":"string"},"parameters":{"description":"Optional. A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of 2MiB.","type":"object","additionalProperties":{"type":"string"}}}},"bigquery_v2_ExternalCatalogTableOptions":{"description":"Metadata about open source compatible table. The fields contained in these options correspond to Hive metastore's table-level properties.","type":"object","properties":{"connectionId":{"description":"Optional. A connection ID that specifies the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or Amazon S3. This connection is needed to read the open source table from BigQuery. The connection_id format must be either `..` or `projects//locations//connections/`.","type":"string"},"parameters":{"description":"Optional. A map of the key-value pairs defining the parameters and properties of the open source table. Corresponds with Hive metastore table parameters. Maximum size of 4MiB.","type":"object","additionalProperties":{"type":"string"}},"storageDescriptor":{"$ref":"#/components/schemas/bigquery_v2_StorageDescriptor"}}},"bigquery_v2_ExternalDataConfiguration":{"type":"object","properties":{"autodetect":{"description":"Try to detect schema and format options automatically. Any option specified explicitly will be honored.","type":"boolean"},"avroOptions":{"$ref":"#/components/schemas/bigquery_v2_AvroOptions"},"bigtableOptions":{"$ref":"#/components/schemas/bigquery_v2_BigtableOptions"},"compression":{"description":"Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.","type":"string"},"connectionId":{"description":"Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form `{project_id}.{location_id};{connection_id}` or `projects/{project_id}/locations/{location_id}/connections/{connection_id}`.","type":"string"},"csvOptions":{"$ref":"#/components/schemas/bigquery_v2_CsvOptions"},"dateFormat":{"description":"Optional. Format used to parse DATE values. Supports C-style and SQL-style values.","type":"string"},"datetimeFormat":{"description":"Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values.","type":"string"},"decimalTargetTypes":{"description":"Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.","type":"array","items":{"enum":["DECIMAL_TARGET_TYPE_UNSPECIFIED","NUMERIC","BIGNUMERIC","STRING"],"type":"string"}},"fileSetSpecType":{"description":"Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.","enum":["FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH","FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST"],"type":"string"},"googleSheetsOptions":{"$ref":"#/components/schemas/bigquery_v2_GoogleSheetsOptions"},"hivePartitioningOptions":{"$ref":"#/components/schemas/bigquery_v2_HivePartitioningOptions"},"ignoreUnknownValues":{"description":"Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.","type":"boolean"},"jsonExtension":{"description":"Optional. Load option to be used together with source_format newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and source_format must be set to NEWLINE_DELIMITED_JSON).","enum":["JSON_EXTENSION_UNSPECIFIED","GEOJSON"],"type":"string"},"jsonOptions":{"$ref":"#/components/schemas/bigquery_v2_JsonOptions"},"maxBadRecords":{"description":"Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.","format":"int32","type":"integer"},"metadataCacheMode":{"description":"Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.","enum":["METADATA_CACHE_MODE_UNSPECIFIED","AUTOMATIC","MANUAL"],"type":"string"},"objectMetadata":{"description":"Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.","enum":["OBJECT_METADATA_UNSPECIFIED","DIRECTORY","SIMPLE"],"type":"string"},"parquetOptions":{"$ref":"#/components/schemas/bigquery_v2_ParquetOptions"},"referenceFileSchemaUri":{"description":"Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.","type":"string"},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"sourceFormat":{"description":"[Required] The data format. For CSV files, specify \"CSV\". For Google sheets, specify \"GOOGLE_SHEETS\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro files, specify \"AVRO\". For Google Cloud Datastore backups, specify \"DATASTORE_BACKUP\". For Apache Iceberg tables, specify \"ICEBERG\". For ORC files, specify \"ORC\". For Parquet files, specify \"PARQUET\". [Beta] For Google Cloud Bigtable, specify \"BIGTABLE\".","type":"string"},"sourceUris":{"description":"[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.","type":"array","items":{"type":"string"}},"timeFormat":{"description":"Optional. Format used to parse TIME values. Supports C-style and SQL-style values.","type":"string"},"timeZone":{"description":"Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles).","type":"string"},"timestampFormat":{"description":"Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.","type":"string"},"timestampTargetPrecision":{"description":"Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, AVRO, and Iceberg External Table. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.","type":"array","items":{"format":"int32","type":"integer"}}}},"bigquery_v2_ExternalDatasetReference":{"description":"Configures the access a dataset defined in an external metadata storage.","type":"object","properties":{"connection":{"description":"Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id}","type":"string"},"externalSource":{"description":"Required. External source that backs this dataset.","type":"string"}}},"bigquery_v2_ExternalRuntimeOptions":{"description":"Options for the runtime of the external system.","type":"object","properties":{"containerCpu":{"description":"Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits)","format":"double","type":"number"},"containerMemory":{"description":"Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of \"M\", \"G\", \"Mi\" and \"Gi\" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits)","type":"string"},"containerRequestConcurrency":{"description":"Optional. Maximum number of requests that a Python UDF instance can handle concurrently. If absent or if `0`, the default concurrency value is used. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits).","format":"int64","type":"string"},"maxBatchingRows":{"description":"Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.","format":"int64","type":"string"},"runtimeConnection":{"description":"Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```\"projects/{project_id}/locations/{location_id}/connections/{connection_id}\"```","type":"string"},"runtimeVersion":{"description":"Optional. Language runtime version. Example: `python-3.11`.","type":"string"},"volumeMounts":{"description":"Optional. List of volume mounts for the Python UDF container that executes the managed function.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExternalVolumeMount"}}}},"bigquery_v2_ExternalServiceCost":{"description":"The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.","type":"object","properties":{"billingMethod":{"description":"The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility.","type":"string"},"bytesBilled":{"description":"External service cost in terms of bigquery bytes billed.","format":"int64","type":"string"},"bytesProcessed":{"description":"External service cost in terms of bigquery bytes processed.","format":"int64","type":"string"},"externalService":{"description":"External service name.","type":"string"},"reservedSlotCount":{"description":"Non-preemptable reserved slots used for external job. For example, reserved slots for Cloua AI Platform job are the VM usages converted to BigQuery slot with equivalent mount of price.","format":"int64","type":"string"},"slotMs":{"description":"External service cost in terms of bigquery slot milliseconds.","format":"int64","type":"string"}}},"bigquery_v2_ExternalVolumeMount":{"description":"Configuration of a volume mount for the Python UDF container that executes the managed function.","type":"object","properties":{"mountPath":{"description":"Optional. The absolute path within the container where the volume should be mounted.","type":"string"},"sourcePath":{"description":"Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder.","type":"string"}}},"bigquery_v2_FeatureValue":{"description":"Representative value of a single feature within the cluster.","type":"object","properties":{"categoricalValue":{"$ref":"#/components/schemas/bigquery_v2_CategoricalValue"},"featureColumn":{"description":"The feature column name.","type":"string"},"numericalValue":{"description":"The numerical feature value. This is the centroid value for this feature.","format":"double","type":"number"}}},"bigquery_v2_ForeignTypeInfo":{"description":"Metadata about the foreign data type definition such as the system in which the type is defined.","type":"object","properties":{"typeSystem":{"description":"Required. Specifies the system which defines the foreign data type.","enum":["TYPE_SYSTEM_UNSPECIFIED","HIVE"],"type":"string"}}},"bigquery_v2_ForeignViewDefinition":{"description":"A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations.","type":"object","properties":{"dialect":{"description":"Optional. Represents the dialect of the query.","type":"string"},"query":{"description":"Required. The query that defines the view.","type":"string"}}},"bigquery_v2_GenAiErrorStats":{"description":"Provides error statistics for the query job across all AI function calls.","type":"object","properties":{"errors":{"description":"A list of unique errors at query level (up to 5, truncated to 100 chars)","type":"array","items":{"type":"string"}}}},"bigquery_v2_GenAiFunctionCacheStats":{"description":"Provides cache statistics for a GenAi function call.","type":"object","properties":{"numCacheHitRows":{"description":"Number of rows served from cache.","format":"int64","type":"string"}}},"bigquery_v2_GenAiFunctionCostOptimizationStats":{"description":"Provides cost optimization statistics for a GenAi function call.","type":"object","properties":{"message":{"description":"System generated message to provide insights into cost optimization state.","type":"string"},"numCostOptimizedRows":{"description":"Number of rows inferred via cost optimized workflow.","format":"int64","type":"string"}}},"bigquery_v2_GenAiFunctionErrorStats":{"description":"Provides error statistics for a GenAi function call.","type":"object","properties":{"errors":{"description":"A list of unique errors at function level (up to 5, truncated to 100 chars).","type":"array","items":{"type":"string"}},"numFailedRows":{"description":"Number of failed rows processed by the function","format":"int64","type":"string"}}},"bigquery_v2_GenAiFunctionStats":{"description":"Provides statistics for each Ai function call within a query.","type":"object","properties":{"cacheStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionCacheStats"},"costOptimizationStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionCostOptimizationStats"},"errorStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionErrorStats"},"functionName":{"description":"Name of the function.","type":"string"},"numProcessedRows":{"description":"Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows.","format":"int64","type":"string"},"prompt":{"description":"User input prompt of the function (truncated to 20 chars).","type":"string"}}},"bigquery_v2_GenAiStats":{"description":"GenAi stats for the query job.","type":"object","properties":{"errorStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiErrorStats"},"functionStats":{"description":"Function level stats for GenAI Functions. For more information, see [Generative AI overview](https://docs.cloud.google.com/bigquery/docs/generative-ai-overview).","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_GenAiFunctionStats"}}}},"bigquery_v2_GeneratedColumn":{"description":"Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields).","type":"object","properties":{"generatedExpressionInfo":{"$ref":"#/components/schemas/bigquery_v2_GeneratedExpressionInfo"},"generatedMode":{"description":"Optional. Dictates when system generated values are used to populate the field.","enum":["GENERATED_MODE_UNSPECIFIED","GENERATED_ALWAYS","GENERATED_BY_DEFAULT"],"type":"string"}}},"bigquery_v2_GeneratedExpressionInfo":{"description":"Definition of the expression used to generate the field.","type":"object","properties":{"asynchronous":{"description":"Optional. Whether the column generation is done asynchronously.","type":"boolean"},"generationExpression":{"description":"Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field.","type":"string"},"stored":{"description":"Optional. Whether the generated column is stored in the table.","type":"boolean"}}},"bigquery_v2_GetIamPolicyRequest":{"description":"Request message for `GetIamPolicy` method.","type":"object","properties":{"options":{"$ref":"#/components/schemas/bigquery_v2_GetPolicyOptions"}}},"bigquery_v2_GetPolicyOptions":{"description":"Encapsulates settings provided to GetIamPolicy.","type":"object","properties":{"requestedPolicyVersion":{"description":"Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"bigquery_v2_GetQueryResultsResponse":{"description":"Response object of GetQueryResults.","type":"object","properties":{"cacheHit":{"description":"Whether the query result was fetched from the query cache.","type":"boolean"},"errors":{"description":"Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"etag":{"description":"A hash of this response.","type":"string"},"jobComplete":{"description":"Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.","type":"boolean"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"The resource type of the response.","default":"bigquery#getQueryResultsResponse","type":"string"},"numDmlAffectedRows":{"description":"Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.","format":"int64","readOnly":true,"type":"string"},"pageToken":{"description":"A token used for paging results. When this token is non-empty, it indicates additional results are available.","type":"string"},"rows":{"description":"An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. The REST-based representation of this data leverages a series of JSON f,v objects for indicating fields and values.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableRow"}},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"totalBytesProcessed":{"description":"The total number of bytes processed for this query.","format":"int64","type":"string"},"totalRows":{"description":"The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.","format":"uint64","type":"string"}}},"bigquery_v2_GetServiceAccountResponse":{"description":"Response object of GetServiceAccount","type":"object","properties":{"email":{"description":"The service account email address.","type":"string"},"kind":{"description":"The resource type of the response.","default":"bigquery#getServiceAccountResponse","type":"string"}}},"bigquery_v2_GlobalExplanation":{"description":"Global explanations containing the top most important features after training.","type":"object","properties":{"classLabel":{"description":"Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.","type":"string"},"explanations":{"description":"A list of the top global explanations. Sorted by absolute value of attribution in descending order.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Explanation"}}}},"bigquery_v2_GoogleSheetsOptions":{"description":"Options specific to Google Sheets data sources.","type":"object","properties":{"range":{"description":"Optional. Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20","type":"string"},"skipLeadingRows":{"description":"Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.","format":"int64","type":"string"}}},"bigquery_v2_HighCardinalityJoin":{"description":"High cardinality join detailed information.","type":"object","properties":{"leftRows":{"description":"Output only. Count of left input rows.","format":"int64","readOnly":true,"type":"string"},"outputRows":{"description":"Output only. Count of the output rows.","format":"int64","readOnly":true,"type":"string"},"rightRows":{"description":"Output only. Count of right input rows.","format":"int64","readOnly":true,"type":"string"},"stepIndex":{"description":"Output only. The index of the join operator in the ExplainQueryStep lists.","format":"int32","readOnly":true,"type":"integer"}}},"bigquery_v2_HivePartitioningOptions":{"description":"Options for configuring hive partitioning detect.","type":"object","properties":{"fields":{"description":"Output only. For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.","readOnly":true,"type":"array","items":{"type":"string"}},"mode":{"description":"Optional. When set, what mode of hive partitioning to use when reading data. The following modes are supported: * AUTO: automatically infer partition key name(s) and type(s). * STRINGS: automatically infer partition key name(s). All types are strings. * CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported formats are: JSON, CSV, ORC, Avro and Parquet.","type":"string"},"requirePartitionFilter":{"description":"Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with require_partition_filter explicitly set to true will fail.","default":false,"type":"boolean"},"sourceUriPrefix":{"description":"Optional. When hive partition detection is requested, a common prefix for all source uris must be required. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout: gs://bucket/path_to_table/dt=2019-06-01/country=USA/id=7/file.avro gs://bucket/path_to_table/dt=2019-05-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/. CUSTOM detection requires encoding the partitioning schema immediately after the common prefix. For CUSTOM, any of * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:STRING}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:STRING} would all be valid source URI prefixes.","type":"string"}}},"bigquery_v2_HparamSearchSpaces":{"description":"Hyperparameter search spaces. These should be a subset of training_options.","type":"object","properties":{"activationFn":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"batchSize":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"boosterType":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"colsampleBylevel":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"colsampleBynode":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"colsampleBytree":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"dartNormalizeType":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"dropout":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"hiddenUnits":{"$ref":"#/components/schemas/bigquery_v2_IntArrayHparamSearchSpace"},"l1Reg":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"l2Reg":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"learnRate":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"maxTreeDepth":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"minSplitLoss":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"minTreeChildWeight":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"numClusters":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"numFactors":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"numParallelTree":{"$ref":"#/components/schemas/bigquery_v2_IntHparamSearchSpace"},"optimizer":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"subsample":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"},"treeMethod":{"$ref":"#/components/schemas/bigquery_v2_StringHparamSearchSpace"},"walsAlpha":{"$ref":"#/components/schemas/bigquery_v2_DoubleHparamSearchSpace"}}},"bigquery_v2_HparamTuningTrial":{"description":"Training info of a trial in [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.","type":"object","properties":{"endTimeMs":{"description":"Ending time of the trial.","format":"int64","type":"string"},"errorMessage":{"description":"Error message for FAILED and INFEASIBLE trial.","type":"string"},"evalLoss":{"description":"Loss computed on the eval data at the end of trial.","format":"double","type":"number"},"evaluationMetrics":{"$ref":"#/components/schemas/bigquery_v2_EvaluationMetrics"},"hparamTuningEvaluationMetrics":{"$ref":"#/components/schemas/bigquery_v2_EvaluationMetrics"},"hparams":{"$ref":"#/components/schemas/bigquery_v2_TrainingOptions"},"startTimeMs":{"description":"Starting time of the trial.","format":"int64","type":"string"},"status":{"description":"The status of the trial.","enum":["TRIAL_STATUS_UNSPECIFIED","NOT_STARTED","RUNNING","SUCCEEDED","FAILED","INFEASIBLE","STOPPED_EARLY"],"type":"string"},"trainingLoss":{"description":"Loss computed on the training data at the end of trial.","format":"double","type":"number"},"trialId":{"description":"1-based index of the trial.","format":"int64","type":"string"}}},"bigquery_v2_IncrementalResultStats":{"description":"Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available.","type":"object","properties":{"disabledReason":{"description":"Output only. Reason why incremental query results are/were not written by the query.","readOnly":true,"enum":["DISABLED_REASON_UNSPECIFIED","OTHER","UNSUPPORTED_OPERATOR"],"type":"string"},"disabledReasonDetails":{"description":"Output only. Additional human-readable clarification, if available, for DisabledReason.","readOnly":true,"type":"string"},"firstIncrementalRowTime":{"description":"Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.","format":"google-datetime","readOnly":true,"type":"string"},"incrementalRowCount":{"description":"Output only. Number of rows that were in the latest result set before query completion.","format":"int64","readOnly":true,"type":"string"},"lastIncrementalRowTime":{"description":"Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.","format":"google-datetime","readOnly":true,"type":"string"},"resultSetLastModifyTime":{"description":"Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.","format":"google-datetime","readOnly":true,"type":"string"},"resultSetLastReplaceTime":{"description":"Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.","format":"google-datetime","readOnly":true,"type":"string"}}},"bigquery_v2_IndexPruningStats":{"description":"Statistics for index pruning.","type":"object","properties":{"baseTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"indexId":{"description":"The index id.","type":"string"},"postIndexPruningParallelInputCount":{"description":"The number of parallel inputs after index pruning.","format":"int64","type":"string"},"preIndexPruningParallelInputCount":{"description":"The number of parallel inputs before index pruning.","format":"int64","type":"string"}}},"bigquery_v2_IndexUnusedReason":{"description":"Reason about why no search index was used in the search query (or sub-query).","type":"object","properties":{"baseTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"code":{"description":"Specifies the high-level reason for the scenario when no search index was used.","enum":["CODE_UNSPECIFIED","INDEX_CONFIG_NOT_AVAILABLE","PENDING_INDEX_CREATION","BASE_TABLE_TRUNCATED","INDEX_CONFIG_MODIFIED","TIME_TRAVEL_QUERY","NO_PRUNING_POWER","UNINDEXED_SEARCH_FIELDS","UNSUPPORTED_SEARCH_PATTERN","OPTIMIZED_WITH_MATERIALIZED_VIEW","SECURED_BY_DATA_MASKING","MISMATCHED_TEXT_ANALYZER","BASE_TABLE_TOO_SMALL","BASE_TABLE_TOO_LARGE","ESTIMATED_PERFORMANCE_GAIN_TOO_LOW","COLUMN_METADATA_INDEX_NOT_USED","NOT_SUPPORTED_IN_STANDARD_EDITION","INDEX_SUPPRESSED_BY_FUNCTION_OPTION","QUERY_CACHE_HIT","STALE_INDEX","INTERNAL_ERROR","OTHER_REASON"],"type":"string"},"indexName":{"description":"Specifies the name of the unused search index, if available.","type":"string"},"message":{"description":"Free form human-readable reason for the scenario when no search index was used.","type":"string"}}},"bigquery_v2_InputDataChange":{"description":"Details about the input data change insight.","type":"object","properties":{"recordsReadDiffPercentage":{"description":"Output only. Records read difference percentage compared to a previous run.","format":"float","readOnly":true,"type":"number"}}},"bigquery_v2_IntArray":{"description":"An array of int.","type":"object","properties":{"elements":{"description":"Elements in the int array.","type":"array","items":{"format":"int64","type":"string"}}}},"bigquery_v2_IntArrayHparamSearchSpace":{"description":"Search space for int array.","type":"object","properties":{"candidates":{"description":"Candidates for the int array parameter.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IntArray"}}}},"bigquery_v2_IntCandidates":{"description":"Discrete candidates of an int hyperparameter.","type":"object","properties":{"candidates":{"description":"Candidates for the int parameter in increasing order.","type":"array","items":{"format":"int64","type":"string"}}}},"bigquery_v2_IntHparamSearchSpace":{"description":"Search space for an int hyperparameter.","type":"object","properties":{"candidates":{"$ref":"#/components/schemas/bigquery_v2_IntCandidates"},"range":{"$ref":"#/components/schemas/bigquery_v2_IntRange"}}},"bigquery_v2_IntRange":{"description":"Range of an int hyperparameter.","type":"object","properties":{"max":{"description":"Max value of the int parameter.","format":"int64","type":"string"},"min":{"description":"Min value of the int parameter.","format":"int64","type":"string"}}},"bigquery_v2_IterationResult":{"description":"Information about a single iteration of the training run.","type":"object","properties":{"arimaResult":{"$ref":"#/components/schemas/bigquery_v2_ArimaResult"},"clusterInfos":{"description":"Information about top clusters for clustering models.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ClusterInfo"}},"durationMs":{"description":"Time taken to run the iteration in milliseconds.","format":"int64","type":"string"},"evalLoss":{"description":"Loss computed on the eval data at the end of iteration.","format":"double","type":"number"},"index":{"description":"Index of the iteration, 0 based.","format":"int32","type":"integer"},"learnRate":{"description":"Learn rate used for this iteration.","format":"double","type":"number"},"principalComponentInfos":{"description":"The information of the principal components.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_PrincipalComponentInfo"}},"trainingLoss":{"description":"Loss computed on the training data at the end of iteration.","format":"double","type":"number"}}},"bigquery_v2_Job":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/bigquery_v2_JobConfiguration"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"id":{"description":"Output only. Opaque ID field of the job.","readOnly":true,"type":"string"},"jobCreationReason":{"$ref":"#/components/schemas/bigquery_v2_JobCreationReason"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"Output only. The type of the resource.","readOnly":true,"default":"bigquery#job","type":"string"},"principal_subject":{"description":"Output only. [Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities.","readOnly":true,"type":"string"},"selfLink":{"description":"Output only. A URL that can be used to access the resource again.","readOnly":true,"type":"string"},"statistics":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics"},"status":{"$ref":"#/components/schemas/bigquery_v2_JobStatus"},"user_email":{"description":"Output only. Email address of the user who ran the job.","readOnly":true,"type":"string"}}},"bigquery_v2_JobCancelResponse":{"description":"Describes format of a jobs cancellation response.","type":"object","properties":{"job":{"$ref":"#/components/schemas/bigquery_v2_Job"},"kind":{"description":"The resource type of the response.","default":"bigquery#jobCancelResponse","type":"string"}}},"bigquery_v2_JobConfiguration":{"type":"object","properties":{"copy":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationTableCopy"},"dryRun":{"description":"Optional. If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.","type":"boolean"},"extract":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationExtract"},"jobTimeoutMs":{"description":"Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.","format":"int64","type":"string"},"jobType":{"description":"Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.","type":"string"},"labels":{"description":"The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"load":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationLoad"},"maxSlots":{"description":"Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.","format":"int32","type":"integer"},"query":{"$ref":"#/components/schemas/bigquery_v2_JobConfigurationQuery"},"reservation":{"description":"Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`.","type":"string"}}},"bigquery_v2_JobConfigurationExtract":{"description":"JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.","type":"object","properties":{"compression":{"description":"Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models.","type":"string"},"destinationFormat":{"description":"Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.","type":"string"},"destinationUri":{"description":"[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.","type":"string"},"destinationUris":{"description":"[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.","type":"array","items":{"type":"string"}},"fieldDelimiter":{"description":"Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.","type":"string"},"modelExtractOptions":{"$ref":"#/components/schemas/bigquery_v2_ModelExtractOptions"},"nativeGeographyExportEnabled":{"description":"Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type.","type":"boolean"},"printHeader":{"description":"Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.","default":true,"type":"boolean"},"sourceModel":{"$ref":"#/components/schemas/bigquery_v2_ModelReference"},"sourceTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"useAvroLogicalTypes":{"description":"Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.","type":"boolean"}}},"bigquery_v2_JobConfigurationLoad":{"description":"JobConfigurationLoad contains the configuration properties for loading data into a destination table.","type":"object","properties":{"allowJaggedRows":{"description":"Optional. Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.","type":"boolean"},"allowQuotedNewlines":{"description":"Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.","type":"boolean"},"autodetect":{"description":"Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources.","type":"boolean"},"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"columnNameCharacterMap":{"description":"Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error.","enum":["COLUMN_NAME_CHARACTER_MAP_UNSPECIFIED","STRICT","V1","V2"],"type":"string"},"connectionProperties":{"description":"Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConnectionProperty"}},"copyFilesOnly":{"description":"Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified.","type":"boolean"},"createDisposition":{"description":"Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"createSession":{"description":"Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic.","type":"boolean"},"dateFormat":{"description":"Optional. Date format used for parsing DATE values.","type":"string"},"datetimeFormat":{"description":"Optional. Date format used for parsing DATETIME values.","type":"string"},"decimalTargetTypes":{"description":"Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.","type":"array","items":{"enum":["DECIMAL_TARGET_TYPE_UNSPECIFIED","NUMERIC","BIGNUMERIC","STRING"],"type":"string"}},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"destinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"destinationTableProperties":{"$ref":"#/components/schemas/bigquery_v2_DestinationTableProperties"},"encoding":{"description":"Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the `quote` and `fieldDelimiter` properties. If you don't specify an encoding, or if you specify a UTF-8 encoding when the CSV file is not UTF-8 encoded, BigQuery attempts to convert the data to UTF-8. Generally, your data loads successfully, but it may not match byte-for-byte what you expect. To avoid this, specify the correct encoding by using the `--encoding` flag. If BigQuery can't convert a character other than the ASCII `0` character, BigQuery converts the character to the standard Unicode replacement character: �.","type":"string"},"fieldDelimiter":{"description":"Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence \"\\t\" (U+0009) to specify a tab separator. The default value is comma (\",\", U+002C).","type":"string"},"fileSetSpecType":{"description":"Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default, source URIs are expanded against the underlying storage. You can also specify manifest files to control how the file set is constructed. This option is only applicable to object storage systems.","enum":["FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH","FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST"],"type":"string"},"hivePartitioningOptions":{"$ref":"#/components/schemas/bigquery_v2_HivePartitioningOptions"},"ignoreUnknownValues":{"description":"Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema.","type":"boolean"},"jsonExtension":{"description":"Optional. Load option to be used together with source_format newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and source_format must be set to NEWLINE_DELIMITED_JSON).","enum":["JSON_EXTENSION_UNSPECIFIED","GEOJSON"],"type":"string"},"maxBadRecords":{"description":"Optional. The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This is only supported for CSV and NEWLINE_DELIMITED_JSON file formats.","format":"int32","type":"integer"},"nullMarker":{"description":"Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify \"\\N\", BigQuery interprets \"\\N\" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.","type":"string"},"nullMarkers":{"description":"Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.","type":"array","items":{"type":"string"}},"parquetOptions":{"$ref":"#/components/schemas/bigquery_v2_ParquetOptions"},"preserveAsciiControlCharacters":{"description":"Optional. When sourceFormat is set to \"CSV\", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\\x00' to '\\x1F') are preserved.","type":"boolean"},"projectionFields":{"description":"If sourceFormat is set to \"DATASTORE_BACKUP\", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.","type":"array","items":{"type":"string"}},"quote":{"description":"Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' \" ', use ' \"\" '. @default \"","default":"\"","type":"string"},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"referenceFileSchemaUri":{"description":"Optional. The user can provide a reference file with the reader schema. This file is only loaded if it is part of source URIs, but is not loaded otherwise. It is enabled for the following formats: AVRO, PARQUET, ORC.","type":"string"},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"schemaInline":{"description":"[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\".","type":"string"},"schemaInlineFormat":{"description":"[Deprecated] The format of the schemaInline property.","type":"string"},"schemaUpdateOptions":{"description":"Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.","type":"array","items":{"type":"string"}},"skipLeadingRows":{"description":"Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.","format":"int32","type":"integer"},"sourceColumnMatch":{"description":"Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible.","enum":["SOURCE_COLUMN_MATCH_UNSPECIFIED","POSITION","NAME"],"type":"string"},"sourceFormat":{"description":"Optional. The format of the data files. For CSV files, specify \"CSV\". For datastore backups, specify \"DATASTORE_BACKUP\". For newline-delimited JSON, specify \"NEWLINE_DELIMITED_JSON\". For Avro, specify \"AVRO\". For parquet, specify \"PARQUET\". For orc, specify \"ORC\". The default value is CSV.","type":"string"},"sourceUris":{"description":"[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.","type":"array","items":{"type":"string"}},"timeFormat":{"description":"Optional. Date format used for parsing TIME values.","type":"string"},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"timeZone":{"description":"Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone.","type":"string"},"timestampFormat":{"description":"Optional. Date format used for parsing TIMESTAMP values.","type":"string"},"timestampTargetPrecision":{"description":"Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, AVRO, and Iceberg External Table. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated.","type":"array","items":{"format":"int32","type":"integer"}},"useAvroLogicalTypes":{"description":"Optional. If sourceFormat is set to \"AVRO\", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).","type":"boolean"},"writeDisposition":{"description":"Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"}}},"bigquery_v2_JobConfigurationQuery":{"description":"JobConfigurationQuery configures a BigQuery query job.","type":"object","properties":{"allowLargeResults":{"description":"Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.","default":false,"type":"boolean"},"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"connectionProperties":{"description":"Connection properties which can modify the query behavior.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConnectionProperty"}},"continuous":{"description":"[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.","type":"boolean"},"createDisposition":{"description":"Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"createSession":{"description":"If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic.","type":"boolean"},"defaultDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"destinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"flattenResults":{"description":"Optional. If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For GoogleSQL queries, this flag is ignored and results are never flattened.","default":true,"type":"boolean"},"maximumBillingTier":{"description":"Optional. [Deprecated] Maximum billing tier allowed for this query. The billing tier controls the amount of compute resources allotted to the query, and multiplies the on-demand cost of the query accordingly. A query that runs within its allotted resources will succeed and indicate its billing tier in statistics.query.billingTier, but if the query exceeds its allotted resources, it will fail with billingTierLimitExceeded. WARNING: The billed byte amount can be multiplied by an amount up to this number! Most users should not need to alter this setting, and we recommend that you avoid introducing new uses of it.","format":"int32","default":1,"type":"integer"},"maximumBytesBilled":{"description":"Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.","format":"int64","type":"string"},"parameterMode":{"description":"GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.","type":"string"},"preserveNulls":{"description":"[Deprecated] This property is deprecated.","type":"boolean"},"priority":{"description":"Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.","type":"string"},"query":{"description":"[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL.","type":"string"},"queryParameters":{"description":"Query parameters for GoogleSQL queries.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameter"}},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"schemaUpdateOptions":{"description":"Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.","type":"array","items":{"type":"string"}},"scriptOptions":{"$ref":"#/components/schemas/bigquery_v2_ScriptOptions"},"secureContext":{"$ref":"#/components/schemas/bigquery_v2_SecureContext"},"systemVariables":{"$ref":"#/components/schemas/bigquery_v2_SystemVariables"},"tableDefinitions":{"description":"Optional. You can specify external table definitions, which operate as ephemeral tables that can be queried. These definitions are configured using a JSON map, where the string key represents the table identifier, and the value is the corresponding external data configuration object.","type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_ExternalDataConfiguration"}},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"useLegacySql":{"description":"Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.","default":true,"type":"boolean"},"useQueryCache":{"description":"Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.","default":true,"type":"boolean"},"userDefinedFunctionResources":{"description":"Describes user-defined function resources used in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_UserDefinedFunctionResource"}},"writeDisposition":{"description":"Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"writeIncrementalResults":{"description":"Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.","type":"boolean"}}},"bigquery_v2_JobConfigurationTableCopy":{"description":"JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see [Copy a table](https://cloud.google.com/bigquery/docs/managing-tables#copy-table).","type":"object","properties":{"createDisposition":{"description":"Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"destinationExpirationTime":{"description":"Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.","format":"google-datetime","type":"string"},"destinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"operationType":{"description":"Optional. Supported operation types in table copy job.","enum":["OPERATION_TYPE_UNSPECIFIED","COPY","SNAPSHOT","RESTORE","CLONE"],"type":"string"},"sourceTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"sourceTables":{"description":"[Pick one] Source tables to copy.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"writeDisposition":{"description":"Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema and table constraints from the source table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.","type":"string"}}},"bigquery_v2_JobCreationReason":{"description":"Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`.","type":"object","properties":{"code":{"description":"Output only. Specifies the high level reason why a Job was created.","readOnly":true,"enum":["CODE_UNSPECIFIED","REQUESTED","LONG_RUNNING","LARGE_RESULTS","OTHER"],"type":"string"}}},"bigquery_v2_JobList":{"description":"JobList is the response format for a jobs.list call.","type":"object","properties":{"etag":{"description":"A hash of this page of results.","type":"string"},"jobs":{"description":"List of jobs that were requested.","type":"array","items":{"description":"ListFormatJob is a partial projection of job information returned as part of a jobs.list response.","type":"object","properties":{"configuration":{"$ref":"#/components/schemas/bigquery_v2_JobConfiguration"},"errorResult":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"id":{"description":"Unique opaque ID of the job.","type":"string"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"The resource type.","type":"string"},"principal_subject":{"description":"[Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities.","type":"string"},"state":{"description":"Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.","type":"string"},"statistics":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics"},"status":{"$ref":"#/components/schemas/bigquery_v2_JobStatus"},"user_email":{"description":"[Full-projection-only] Email address of the user who ran the job.","type":"string"}}}},"kind":{"description":"The resource type of the response.","default":"bigquery#jobList","type":"string"},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"unreachable":{"description":"A list of skipped locations that were unreachable. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations. Example: \"europe-west5\"","type":"array","items":{"type":"string"}}}},"bigquery_v2_JobReference":{"description":"A job reference is a fully qualified identifier for referring to a job.","type":"object","properties":{"jobId":{"description":"Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.","type":"string"},"location":{"description":"Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations","type":"string"},"projectId":{"description":"Required. The ID of the project containing this job.","type":"string"}}},"bigquery_v2_JobStatistics":{"description":"Statistics for a single job execution.","type":"object","properties":{"completionRatio":{"description":"Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.","format":"double","readOnly":true,"type":"number"},"copy":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics5"},"creationTime":{"description":"Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.","format":"int64","readOnly":true,"type":"string"},"dataMaskingStatistics":{"$ref":"#/components/schemas/bigquery_v2_DataMaskingStatistics"},"edition":{"description":"Output only. Name of edition corresponding to the reservation for this job at the time of this update.","readOnly":true,"enum":["RESERVATION_EDITION_UNSPECIFIED","STANDARD","ENTERPRISE","ENTERPRISE_PLUS"],"type":"string"},"endTime":{"description":"Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.","format":"int64","readOnly":true,"type":"string"},"extract":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics4"},"finalExecutionDurationMs":{"description":"Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job.","format":"int64","readOnly":true,"type":"string"},"globalQueryRemoteRegions":{"description":"Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries).","readOnly":true,"type":"array","items":{"type":"string"}},"load":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics3"},"numChildJobs":{"description":"Output only. Number of child jobs executed.","format":"int64","readOnly":true,"type":"string"},"parentGlobalQueryJob":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"parentJobId":{"description":"Output only. If this is a child job, specifies the job ID of the parent.","readOnly":true,"type":"string"},"query":{"$ref":"#/components/schemas/bigquery_v2_JobStatistics2"},"quotaDeferments":{"description":"Output only. Quotas which delayed this job's start time.","readOnly":true,"type":"array","items":{"type":"string"}},"reservationGroupPath":{"description":"Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group.","readOnly":true,"type":"array","items":{"type":"string"}},"reservationUsage":{"description":"Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.","readOnly":true,"type":"array","items":{"description":"Job resource usage breakdown by reservation.","type":"object","properties":{"name":{"description":"Reservation name or \"unreserved\" for on-demand resource usage and multi-statement queries.","type":"string"},"slotMs":{"description":"Total slot milliseconds used by the reservation for a particular job.","format":"int64","type":"string"}}}},"reservation_id":{"description":"Output only. Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.","readOnly":true,"type":"string"},"rowLevelSecurityStatistics":{"$ref":"#/components/schemas/bigquery_v2_RowLevelSecurityStatistics"},"scriptStatistics":{"$ref":"#/components/schemas/bigquery_v2_ScriptStatistics"},"sessionInfo":{"$ref":"#/components/schemas/bigquery_v2_SessionInfo"},"startTime":{"description":"Output only. Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessed":{"description":"Output only. Total bytes processed for the job.","format":"int64","readOnly":true,"type":"string"},"totalSlotMs":{"description":"Output only. Slot-milliseconds for the job.","format":"int64","readOnly":true,"type":"string"},"transactionInfo":{"$ref":"#/components/schemas/bigquery_v2_TransactionInfo"}}},"bigquery_v2_JobStatistics2":{"description":"Statistics for a query job.","type":"object","properties":{"biEngineStatistics":{"$ref":"#/components/schemas/bigquery_v2_BiEngineStatistics"},"billingTier":{"description":"Output only. Billing tier for the job. This is a BigQuery-specific concept which is not related to the Google Cloud notion of \"free tier\". The value here is a measure of the query's resource consumption relative to the amount of data scanned. For on-demand queries, the limit is 100, and all queries within this limit are billed at the standard on-demand rates. On-demand queries that exceed this limit will fail with a billingTierLimitExceeded error.","format":"int32","readOnly":true,"type":"integer"},"cacheHit":{"description":"Output only. Whether the query result was fetched from the query cache.","readOnly":true,"type":"boolean"},"dclTargetDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"dclTargetTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"dclTargetView":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"ddlAffectedRowAccessPolicyCount":{"description":"Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.","format":"int64","readOnly":true,"type":"string"},"ddlDestinationTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"ddlOperationPerformed":{"description":"Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target.","readOnly":true,"type":"string"},"ddlTargetDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"ddlTargetRoutine":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"},"ddlTargetRowAccessPolicy":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicyReference"},"ddlTargetTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"dmlStats":{"$ref":"#/components/schemas/bigquery_v2_DmlStatistics"},"estimatedBytesProcessed":{"description":"Output only. The original estimate of bytes processed for the job.","format":"int64","readOnly":true,"type":"string"},"exportDataStatistics":{"$ref":"#/components/schemas/bigquery_v2_ExportDataStatistics"},"externalServiceCosts":{"description":"Output only. Job cost breakdown as bigquery internal cost and external service costs.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExternalServiceCost"}},"genAiStats":{"$ref":"#/components/schemas/bigquery_v2_GenAiStats"},"incrementalResultStats":{"$ref":"#/components/schemas/bigquery_v2_IncrementalResultStats"},"loadQueryStatistics":{"$ref":"#/components/schemas/bigquery_v2_LoadQueryStatistics"},"materializedViewStatistics":{"$ref":"#/components/schemas/bigquery_v2_MaterializedViewStatistics"},"metadataCacheStatistics":{"$ref":"#/components/schemas/bigquery_v2_MetadataCacheStatistics"},"mlStatistics":{"$ref":"#/components/schemas/bigquery_v2_MlStatistics"},"modelTraining":{"$ref":"#/components/schemas/bigquery_v2_BigQueryModelTraining"},"modelTrainingCurrentIteration":{"description":"Deprecated.","format":"int32","type":"integer"},"modelTrainingExpectedTotalIteration":{"description":"Deprecated.","format":"int64","type":"string"},"numDmlAffectedRows":{"description":"Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.","format":"int64","readOnly":true,"type":"string"},"objectStorageStats":{"description":"Output only. Storage and caching statistics per cloud provider for queries over object storage.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ObjectStorageStats"}},"performanceInsights":{"$ref":"#/components/schemas/bigquery_v2_PerformanceInsights"},"queryInfo":{"$ref":"#/components/schemas/bigquery_v2_QueryInfo"},"queryPlan":{"description":"Output only. Describes execution plan for the query.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ExplainQueryStage"}},"referencedLogicalViews":{"description":"Output only. Referenced logical views for the job.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"referencedPropertyGraphs":{"description":"Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_PropertyGraphReference"}},"referencedRoutines":{"description":"Output only. Referenced routines for the job.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"}},"referencedTables":{"description":"Output only. Referenced tables for the job.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"reservationUsage":{"description":"Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.","readOnly":true,"type":"array","items":{"description":"Job resource usage breakdown by reservation.","type":"object","properties":{"name":{"description":"Reservation name or \"unreserved\" for on-demand resource usage and multi-statement queries.","type":"string"},"slotMs":{"description":"Total slot milliseconds used by the reservation for a particular job.","format":"int64","type":"string"}}}},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"searchStatistics":{"$ref":"#/components/schemas/bigquery_v2_SearchStatistics"},"sparkStatistics":{"$ref":"#/components/schemas/bigquery_v2_SparkStatistics"},"statementType":{"description":"Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement.","readOnly":true,"type":"string"},"timeline":{"description":"Output only. Describes a timeline of job execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryTimelineSample"}},"totalBytesBilled":{"description":"Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessed":{"description":"Output only. Total bytes processed for the job.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessedAccuracy":{"description":"Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.","readOnly":true,"type":"string"},"totalPartitionsProcessed":{"description":"Output only. Total number of partitions processed from all partitioned tables referenced in the job.","format":"int64","readOnly":true,"type":"string"},"totalServicesSkuSlotMs":{"description":"Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `\"SERVICES_SKU\"`.","format":"int64","readOnly":true,"type":"string"},"totalSlotMs":{"description":"Output only. Slot-milliseconds for the job.","format":"int64","readOnly":true,"type":"string"},"transferredBytes":{"description":"Output only. Total bytes transferred for BigQuery Omni queries from the remote cloud back to Google Cloud. This tracks data movement over Google-managed connections (like query results). It doesn't include input data read from the external data lake (for example, S3) because that data stays within the remote cloud.","format":"int64","readOnly":true,"type":"string"},"undeclaredQueryParameters":{"description":"Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameter"}},"vectorSearchStatistics":{"$ref":"#/components/schemas/bigquery_v2_VectorSearchStatistics"}}},"bigquery_v2_JobStatistics3":{"description":"Statistics for a load job.","type":"object","properties":{"badRecords":{"description":"Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.","format":"int64","readOnly":true,"type":"string"},"inputFileBytes":{"description":"Output only. Number of bytes of source data in a load job.","format":"int64","readOnly":true,"type":"string"},"inputFiles":{"description":"Output only. Number of source files in a load job.","format":"int64","readOnly":true,"type":"string"},"outputBytes":{"description":"Output only. Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"},"outputRows":{"description":"Output only. Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"},"timeline":{"description":"Output only. Describes a timeline of job execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryTimelineSample"}}}},"bigquery_v2_JobStatistics4":{"description":"Statistics for an extract job.","type":"object","properties":{"destinationUriFileCounts":{"description":"Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.","readOnly":true,"type":"array","items":{"format":"int64","type":"string"}},"inputBytes":{"description":"Output only. Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes and doesn't have any relationship with the number of actual result bytes extracted in the desired format.","format":"int64","readOnly":true,"type":"string"},"timeline":{"description":"Output only. Describes a timeline of job execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryTimelineSample"}}}},"bigquery_v2_JobStatistics5":{"description":"Statistics for a copy job.","type":"object","properties":{"copiedLogicalBytes":{"description":"Output only. Number of logical bytes copied to the destination table.","format":"int64","readOnly":true,"type":"string"},"copiedRows":{"description":"Output only. Number of rows copied to the destination table.","format":"int64","readOnly":true,"type":"string"},"remoteDestinationRegion":{"description":"Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs.","readOnly":true,"type":"string"}}},"bigquery_v2_JobStatus":{"type":"object","properties":{"errorResult":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"errors":{"description":"Output only. The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has not completed or was unsuccessful.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"state":{"description":"Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.","readOnly":true,"type":"string"}}},"bigquery_v2_JoinRestrictionPolicy":{"description":"Represents privacy policy associated with \"join restrictions\". Join restriction gives data providers the ability to enforce joins on the 'join_allowed_columns' when data is queried from a privacy protected view.","type":"object","properties":{"joinAllowedColumns":{"description":"Optional. The only columns that joins are allowed on. This field is must be specified for join_conditions JOIN_ANY and JOIN_ALL and it cannot be set for JOIN_BLOCKED.","type":"array","items":{"type":"string"}},"joinCondition":{"description":"Optional. Specifies if a join is required or not on queries for the view. Default is JOIN_CONDITION_UNSPECIFIED.","enum":["JOIN_CONDITION_UNSPECIFIED","JOIN_ANY","JOIN_ALL","JOIN_NOT_REQUIRED","JOIN_BLOCKED"],"type":"string"}}},"bigquery_v2_JsonObject":{"description":"Represents a single JSON object.","type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_JsonValue"}},"bigquery_v2_JsonOptions":{"description":"Json Options for load and make external tables.","type":"object","properties":{"encoding":{"description":"Optional. The character encoding of the data. The supported values are UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8.","type":"string"}}},"bigquery_v2_JsonValue":{},"bigquery_v2_LinkedDatasetMetadata":{"description":"Metadata about the Linked Dataset.","type":"object","properties":{"linkState":{"description":"Output only. Specifies whether Linked Dataset is currently in a linked state or not.","readOnly":true,"enum":["LINK_STATE_UNSPECIFIED","LINKED","UNLINKED"],"type":"string"}}},"bigquery_v2_LinkedDatasetSource":{"description":"A dataset source type which refers to another BigQuery dataset.","type":"object","properties":{"sourceDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"}}},"bigquery_v2_ListModelsResponse":{"description":"Response format for a single page when listing BigQuery ML models.","type":"object","properties":{"models":{"description":"Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Model"}},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"}}},"bigquery_v2_ListRoutinesResponse":{"description":"Describes the format of a single result page when listing routines.","type":"object","properties":{"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"routines":{"description":"Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, language, and remote_function_options.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Routine"}}}},"bigquery_v2_ListRowAccessPoliciesResponse":{"description":"Response message for the ListRowAccessPolicies method.","type":"object","properties":{"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"rowAccessPolicies":{"description":"Row access policies on the requested table.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicy"}}}},"bigquery_v2_LoadQueryStatistics":{"description":"Statistics for a LOAD query.","type":"object","properties":{"badRecords":{"description":"Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.","format":"int64","readOnly":true,"type":"string"},"bytesTransferred":{"description":"Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing.","format":"int64","readOnly":true,"type":"string"},"inputFileBytes":{"description":"Output only. Number of bytes of source data in a LOAD query.","format":"int64","readOnly":true,"type":"string"},"inputFiles":{"description":"Output only. Number of source files in a LOAD query.","format":"int64","readOnly":true,"type":"string"},"outputBytes":{"description":"Output only. Size of the loaded data in bytes. Note that while a LOAD query is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"},"outputRows":{"description":"Output only. Number of rows imported in a LOAD query. Note that while a LOAD query is in the running state, this value may change.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_LocationMetadata":{"description":"BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.","type":"object","properties":{"legacyLocationId":{"description":"The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations.","type":"string"}}},"bigquery_v2_MaterializedView":{"description":"A materialized view considered for a query job.","type":"object","properties":{"chosen":{"description":"Whether the materialized view is chosen for the query. A materialized view can be chosen to rewrite multiple parts of the same query. If a materialized view is chosen to rewrite any part of the query, then this field is true, even if the materialized view was not chosen to rewrite others parts.","type":"boolean"},"estimatedBytesSaved":{"description":"If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables.","format":"int64","type":"string"},"rejectedReason":{"description":"If present, specifies the reason why the materialized view was not chosen for the query.","enum":["REJECTED_REASON_UNSPECIFIED","NO_DATA","COST","BASE_TABLE_TRUNCATED","BASE_TABLE_DATA_CHANGE","BASE_TABLE_PARTITION_EXPIRATION_CHANGE","BASE_TABLE_EXPIRED_PARTITION","BASE_TABLE_INCOMPATIBLE_METADATA_CHANGE","TIME_ZONE","OUT_OF_TIME_TRAVEL_WINDOW","BASE_TABLE_FINE_GRAINED_SECURITY_POLICY","BASE_TABLE_TOO_STALE"],"type":"string"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_MaterializedViewDefinition":{"description":"Definition and configuration of a materialized view.","type":"object","properties":{"allowNonIncrementalDefinition":{"description":"Optional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. Non-incremental materialized views support an expanded range of SQL queries. The `allow_non_incremental_definition` option can't be changed after the materialized view is created.","type":"boolean"},"enableRefresh":{"description":"Optional. Enable automatic refresh of the materialized view when the base table is updated. The default value is \"true\".","type":"boolean"},"lastRefreshTime":{"description":"Output only. The time when this materialized view was last refreshed, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"maxStaleness":{"description":"[Optional] Max staleness of data that could be returned when materizlized view is queried (formatted as Google SQL Interval type).","format":"byte","type":"string"},"query":{"description":"Required. A query whose results are persisted.","type":"string"},"refreshIntervalMs":{"description":"Optional. The maximum frequency at which this materialized view will be refreshed. The default value is \"1800000\" (30 minutes).","format":"int64","type":"string"}}},"bigquery_v2_MaterializedViewStatistics":{"description":"Statistics of materialized views considered in a query job.","type":"object","properties":{"materializedView":{"description":"Materialized views considered for the query job. Only certain materialized views are used. For a detailed list, see the child message. If many materialized views are considered, then the list might be incomplete.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_MaterializedView"}}}},"bigquery_v2_MaterializedViewStatus":{"description":"Status of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message.","type":"object","properties":{"lastRefreshStatus":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"refreshWatermark":{"description":"Output only. Refresh watermark of materialized view. The base tables' data were collected into the materialized view cache until this time.","format":"google-datetime","readOnly":true,"type":"string"}}},"bigquery_v2_MetadataCacheStalenessInsight":{"description":"Column Metadata Index staleness detailed infnormation.","type":"object","properties":{"avgPreviousStalenessMs":{"description":"Output only. Average column metadata index staleness of previous runs with the same query hash.","format":"google-duration","readOnly":true,"type":"string"},"stalenessPercentageIncrease":{"description":"Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash.","format":"double","readOnly":true,"type":"number"}}},"bigquery_v2_MetadataCacheStatistics":{"description":"Statistics for metadata caching in queried tables.","type":"object","properties":{"tableMetadataCacheUsage":{"description":"Set for the Metadata caching eligible tables referenced in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableMetadataCacheUsage"}}}},"bigquery_v2_MlStatistics":{"description":"Job statistics specific to a BigQuery ML training job.","type":"object","properties":{"hparamTrials":{"description":"Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_HparamTuningTrial"}},"iterationResults":{"description":"Results for all completed iterations. Empty for [hyperparameter tuning jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IterationResult"}},"maxIterations":{"description":"Output only. Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.","format":"int64","readOnly":true,"type":"string"},"modelType":{"description":"Output only. The type of the model that is being trained.","readOnly":true,"enum":["MODEL_TYPE_UNSPECIFIED","LINEAR_REGRESSION","LOGISTIC_REGRESSION","KMEANS","MATRIX_FACTORIZATION","DNN_CLASSIFIER","TENSORFLOW","DNN_REGRESSOR","XGBOOST","BOOSTED_TREE_REGRESSOR","BOOSTED_TREE_CLASSIFIER","ARIMA","AUTOML_REGRESSOR","AUTOML_CLASSIFIER","PCA","DNN_LINEAR_COMBINED_CLASSIFIER","DNN_LINEAR_COMBINED_REGRESSOR","AUTOENCODER","ARIMA_PLUS","ARIMA_PLUS_XREG","RANDOM_FOREST_REGRESSOR","RANDOM_FOREST_CLASSIFIER","TENSORFLOW_LITE","ONNX","TRANSFORM_ONLY","CONTRIBUTION_ANALYSIS"],"type":"string"},"trainingType":{"description":"Output only. Training type of the job.","readOnly":true,"enum":["TRAINING_TYPE_UNSPECIFIED","SINGLE_TRAINING","HPARAM_TUNING"],"type":"string"}}},"bigquery_v2_Model":{"type":"object","properties":{"bestTrialId":{"description":"The best trial_id across all training runs.","format":"int64","type":"string"},"creationTime":{"description":"Output only. The time when this model was created, in millisecs since the epoch.","format":"int64","readOnly":true,"type":"string"},"defaultTrialId":{"description":"Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials.","format":"int64","readOnly":true,"type":"string"},"description":{"description":"Optional. A user-friendly description of this model.","type":"string"},"encryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"expirationTime":{"description":"Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.","format":"int64","type":"string"},"featureColumns":{"description":"Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}},"friendlyName":{"description":"Optional. A descriptive name for this model.","type":"string"},"hparamSearchSpaces":{"$ref":"#/components/schemas/bigquery_v2_HparamSearchSpaces"},"hparamTrials":{"description":"Output only. Trials of a [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_HparamTuningTrial"}},"labelColumns":{"description":"Output only. Label columns that were used to train this model. The output of the model will have a \"predicted_\" prefix to these columns.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}},"labels":{"description":"The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The time when this model was last modified, in millisecs since the epoch.","format":"int64","readOnly":true,"type":"string"},"location":{"description":"Output only. The geographic location where the model resides. This value is inherited from the dataset.","readOnly":true,"type":"string"},"modelReference":{"$ref":"#/components/schemas/bigquery_v2_ModelReference"},"modelType":{"description":"Output only. Type of the model resource.","readOnly":true,"enum":["MODEL_TYPE_UNSPECIFIED","LINEAR_REGRESSION","LOGISTIC_REGRESSION","KMEANS","MATRIX_FACTORIZATION","DNN_CLASSIFIER","TENSORFLOW","DNN_REGRESSOR","XGBOOST","BOOSTED_TREE_REGRESSOR","BOOSTED_TREE_CLASSIFIER","ARIMA","AUTOML_REGRESSOR","AUTOML_CLASSIFIER","PCA","DNN_LINEAR_COMBINED_CLASSIFIER","DNN_LINEAR_COMBINED_REGRESSOR","AUTOENCODER","ARIMA_PLUS","ARIMA_PLUS_XREG","RANDOM_FOREST_REGRESSOR","RANDOM_FOREST_CLASSIFIER","TENSORFLOW_LITE","ONNX","TRANSFORM_ONLY","CONTRIBUTION_ANALYSIS"],"type":"string"},"optimalTrialIds":{"description":"Output only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id.","readOnly":true,"type":"array","items":{"format":"int64","type":"string"}},"remoteModelInfo":{"$ref":"#/components/schemas/bigquery_v2_RemoteModelInfo"},"trainingRuns":{"description":"Information for all training runs in increasing order of start_time.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TrainingRun"}},"transformColumns":{"description":"Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TransformColumn"}}}},"bigquery_v2_ModelDefinition":{"type":"object","properties":{"modelOptions":{"description":"Deprecated.","type":"object","properties":{"labels":{"type":"array","items":{"type":"string"}},"lossType":{"type":"string"},"modelType":{"type":"string"}}},"trainingRuns":{"description":"Deprecated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BqmlTrainingRun"}}}},"bigquery_v2_ModelExtractOptions":{"description":"Options related to model extraction.","type":"object","properties":{"trialId":{"description":"The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.","format":"int64","type":"string"}}},"bigquery_v2_ModelReference":{"description":"Id path of a model.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this model.","type":"string"},"modelId":{"description":"Required. The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this model.","type":"string"}}},"bigquery_v2_MultiClassClassificationMetrics":{"description":"Evaluation metrics for multi-class classification/classifier models.","type":"object","properties":{"aggregateClassificationMetrics":{"$ref":"#/components/schemas/bigquery_v2_AggregateClassificationMetrics"},"confusionMatrixList":{"description":"Confusion matrix at different thresholds.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConfusionMatrix"}}}},"bigquery_v2_ObjectStorageStats":{"description":"Storage and caching statistics for object storage.","type":"object","properties":{"cacheBytesRead":{"description":"Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read.","format":"int64","type":"string"},"cloudProvider":{"description":"The cloud provider for this block of statistics.","enum":["CLOUD_PROVIDER_UNSPECIFIED","GCP","AWS","AZURE"],"type":"string"},"objectStorageBytesRead":{"description":"Total bytes read directly from the cloud provider's storage.","format":"int64","type":"string"}}},"bigquery_v2_ParquetOptions":{"description":"Parquet Options for load and make external tables.","type":"object","properties":{"enableListInference":{"description":"Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type.","type":"boolean"},"enumAsString":{"description":"Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.","type":"boolean"},"mapTargetType":{"description":"Optional. Indicates how to represent a Parquet map if present.","enum":["MAP_TARGET_TYPE_UNSPECIFIED","ARRAY_OF_STRUCT"],"type":"string"}}},"bigquery_v2_PartitionSkew":{"description":"Partition skew detailed information.","type":"object","properties":{"skewSources":{"description":"Output only. Source stages which produce skewed data.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_SkewSource"}}}},"bigquery_v2_PartitionedColumn":{"description":"The partitioning column information.","type":"object","properties":{"field":{"description":"Required. The name of the partition column.","type":"string"}}},"bigquery_v2_PartitioningDefinition":{"description":"The partitioning information, which includes managed table, external table and metastore partitioned table partition information.","type":"object","properties":{"partitionedColumn":{"description":"Optional. Details about each partitioning column. This field is output only for all partitioning types other than metastore partitioned tables. BigQuery native tables only support 1 partitioning column. Other table types may support 0, 1 or more partitioning columns. For metastore partitioned tables, the order must match the definition order in the Hive Metastore, where it must match the physical layout of the table. For example, CREATE TABLE a_table(id BIGINT, name STRING) PARTITIONED BY (city STRING, state STRING). In this case the values must be ['city', 'state'] in that order.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_PartitionedColumn"}}}},"bigquery_v2_PerformanceInsights":{"description":"Performance insights for the job.","type":"object","properties":{"avgPreviousExecutionMs":{"description":"Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash.","format":"int64","readOnly":true,"type":"string"},"stagePerformanceChangeInsights":{"description":"Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StagePerformanceChangeInsight"}},"stagePerformanceStandaloneInsights":{"description":"Output only. Standalone query stage performance insights, for exploring potential improvements.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StagePerformanceStandaloneInsight"}},"tableChangeInsights":{"description":"Output only. Performance insights for table-level attributes that changed compared to previous runs.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableChangeInsight"}}}},"bigquery_v2_Policy":{"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).","type":"object","properties":{"auditConfigs":{"description":"Specifies cloud audit logging configuration for this policy.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_AuditConfig"}},"bindings":{"description":"Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Binding"}},"etag":{"description":"`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.","format":"byte","type":"string"},"version":{"description":"Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"bigquery_v2_PrincipalComponentInfo":{"description":"Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.","type":"object","properties":{"cumulativeExplainedVarianceRatio":{"description":"The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.","format":"double","type":"number"},"explainedVariance":{"description":"Explained variance by this principal component, which is simply the eigenvalue.","format":"double","type":"number"},"explainedVarianceRatio":{"description":"Explained_variance over the total explained variance.","format":"double","type":"number"},"principalComponentId":{"description":"Id of the principal component.","format":"int64","type":"string"}}},"bigquery_v2_PrivacyPolicy":{"description":"Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views.","type":"object","properties":{"aggregationThresholdPolicy":{"$ref":"#/components/schemas/bigquery_v2_AggregationThresholdPolicy"},"differentialPrivacyPolicy":{"$ref":"#/components/schemas/bigquery_v2_DifferentialPrivacyPolicy"},"joinRestrictionPolicy":{"$ref":"#/components/schemas/bigquery_v2_JoinRestrictionPolicy"}}},"bigquery_v2_ProjectList":{"description":"Response object of ListProjects","type":"object","properties":{"etag":{"description":"A hash of the page of results.","type":"string"},"kind":{"description":"The resource type of the response.","default":"bigquery#projectList","type":"string"},"nextPageToken":{"description":"Use this token to request the next page of results.","type":"string"},"projects":{"description":"Projects to which the user has at least READ access. This field can be omitted if `totalItems` is 0.","type":"array","items":{"description":"Information about a single project.","type":"object","properties":{"friendlyName":{"description":"A descriptive name for this project. A wrapper is used here because friendlyName can be set to the empty string.","type":"string"},"id":{"description":"An opaque ID of this project.","type":"string"},"kind":{"description":"The resource type.","type":"string"},"numericId":{"description":"The numeric ID of this project.","format":"uint64","type":"string"},"projectReference":{"$ref":"#/components/schemas/bigquery_v2_ProjectReference"}}}},"totalItems":{"description":"The total number of projects in the page. A wrapper is used here because the field should still be in the response when the value is 0.","format":"int32","type":"integer"}}},"bigquery_v2_ProjectReference":{"description":"A unique reference to a project.","type":"object","properties":{"projectId":{"description":"Required. ID of the project. Can be either the numeric ID or the assigned ID of the project.","type":"string"}}},"bigquery_v2_PropertyGraphReference":{"description":"Id path of a property graph.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this property graph.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this property graph.","type":"string"},"propertyGraphId":{"description":"Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.","type":"string"}}},"bigquery_v2_PruningStats":{"description":"The column metadata index pruning statistics.","type":"object","properties":{"postCmetaPruningParallelInputCount":{"description":"The number of parallel inputs matched.","format":"int64","type":"string"},"postCmetaPruningPartitionCount":{"description":"The number of partitions matched.","format":"int64","type":"string"},"preCmetaPruningParallelInputCount":{"description":"The number of parallel inputs scanned.","format":"int64","type":"string"}}},"bigquery_v2_PythonOptions":{"description":"Options for a user-defined Python function.","type":"object","properties":{"entryPoint":{"description":"Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked.","type":"string"},"packages":{"description":"Optional. A list of Python package names along with versions to be installed. Example: [\"pandas>=2.1\", \"google-cloud-translate==3.11\"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages).","type":"array","items":{"type":"string"}}}},"bigquery_v2_QueryInfo":{"description":"Query optimization information for a QUERY job.","type":"object","properties":{"optimizationDetails":{"description":"Output only. Information about query optimizations.","readOnly":true,"type":"object","additionalProperties":{"description":"Properties of the object."}}}},"bigquery_v2_QueryParameter":{"description":"A parameter given to a query.","type":"object","properties":{"name":{"description":"Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query.","type":"string"},"parameterType":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"},"parameterValue":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}}},"bigquery_v2_QueryParameterType":{"description":"The type of a query parameter.","type":"object","properties":{"arrayType":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"},"rangeElementType":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"},"structTypes":{"description":"Optional. The types of the fields of this struct, in order, if this is a struct.","type":"array","items":{"description":"The type of a struct parameter.","type":"object","properties":{"description":{"description":"Optional. Human-oriented description of the field.","type":"string"},"name":{"description":"Optional. The name of this field.","type":"string"},"type":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterType"}}}},"timestampPrecision":{"description":"Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)","format":"int64","default":"6","type":"string"},"type":{"description":"Required. The top level type of this field.","type":"string"}}},"bigquery_v2_QueryParameterValue":{"description":"The value of a query parameter.","type":"object","properties":{"arrayValues":{"description":"Optional. The array values, if this is an array type.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}},"rangeValue":{"$ref":"#/components/schemas/bigquery_v2_RangeValue"},"structValues":{"description":"The struct field values.","type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}},"value":{"description":"Optional. The value of this value, if a simple scalar type.","type":"string"}}},"bigquery_v2_QueryRequest":{"description":"Describes the format of the jobs.query request.","type":"object","properties":{"arrowSerializationOptions":{"$ref":"#/components/schemas/bigquery_v2_ArrowSerializationOptions"},"connectionProperties":{"description":"Optional. Connection properties which can modify the query behavior.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ConnectionProperty"}},"continuous":{"description":"[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.","type":"boolean"},"createSession":{"description":"Optional. If true, creates a new session using a randomly generated session_id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. The session location will be set to QueryRequest.location if it is present, otherwise it's set to the default location based on existing routing logic.","type":"boolean"},"defaultDataset":{"$ref":"#/components/schemas/bigquery_v2_DatasetReference"},"destinationEncryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"dryRun":{"description":"Optional. If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.","type":"boolean"},"formatOptions":{"$ref":"#/components/schemas/bigquery_v2_DataFormatOptions"},"jobCreationMode":{"description":"Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode.","enum":["JOB_CREATION_MODE_UNSPECIFIED","JOB_CREATION_REQUIRED","JOB_CREATION_OPTIONAL"],"type":"string"},"jobTimeoutMs":{"description":"Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. This timeout applies to the query even if a job does not need to be created.","format":"int64","type":"string"},"kind":{"description":"The resource type of the request.","default":"bigquery#queryRequest","type":"string"},"labels":{"description":"Optional. The labels associated with this query. Labels can be used to organize and group query jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"location":{"description":"The geographic location where the job should run. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations).","type":"string"},"maxResults":{"description":"Optional. The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.","format":"uint32","type":"integer"},"maxSlots":{"description":"Optional. A target limit on the rate of slot consumption by this query. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this query to keep it below the configured limit, even if the query is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available.","format":"int32","type":"integer"},"maximumBytesBilled":{"description":"Optional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used.","format":"int64","type":"string"},"parameterMode":{"description":"GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.","type":"string"},"preserveNulls":{"description":"This property is deprecated.","type":"boolean"},"query":{"description":"Required. A query string to execute, using Google Standard SQL or legacy SQL syntax. Example: \"SELECT COUNT(f1) FROM myProjectId.myDatasetId.myTableId\".","type":"string"},"queryParameters":{"description":"Query parameters for GoogleSQL queries.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_QueryParameter"}},"queryResultsFormat":{"description":"Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available.","enum":["QUERY_RESULTS_FORMAT_UNSPECIFIED","STRUCT_ENCODING","ARROW"],"type":"string"},"requestId":{"description":"Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.","type":"string"},"reservation":{"description":"Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`. This requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`.","type":"string"},"secureContext":{"$ref":"#/components/schemas/bigquery_v2_SecureContext"},"timeoutMs":{"description":"Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.","format":"uint32","type":"integer"},"useLegacySql":{"description":"Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.","default":true,"type":"boolean"},"useQueryCache":{"description":"Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.","default":true,"type":"boolean"},"writeIncrementalResults":{"description":"Optional. This is only supported for SELECT query. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available.","type":"boolean"}}},"bigquery_v2_QueryResponse":{"type":"object","properties":{"arrowRecordBatch":{"$ref":"#/components/schemas/bigquery_v2_ArrowRecordBatch"},"arrowSchema":{"$ref":"#/components/schemas/bigquery_v2_ArrowSchema"},"cacheHit":{"description":"Whether the query result was fetched from the query cache.","type":"boolean"},"creationTime":{"description":"Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries.","format":"int64","readOnly":true,"type":"string"},"dmlStats":{"$ref":"#/components/schemas/bigquery_v2_DmlStatistics"},"endTime":{"description":"Output only. End time of this query, in milliseconds since the epoch. This field will be present whenever a query job is in the DONE state.","format":"int64","readOnly":true,"type":"string"},"errors":{"description":"Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"jobComplete":{"description":"Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.","type":"boolean"},"jobCreationReason":{"$ref":"#/components/schemas/bigquery_v2_JobCreationReason"},"jobReference":{"$ref":"#/components/schemas/bigquery_v2_JobReference"},"kind":{"description":"The resource type.","default":"bigquery#queryResponse","type":"string"},"location":{"description":"Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations","readOnly":true,"type":"string"},"numDmlAffectedRows":{"description":"Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.","format":"int64","readOnly":true,"type":"string"},"pageRowCount":{"description":"Output only. The number of rows out of `total_rows` returned in this response. This feature is not yet available.","format":"int64","readOnly":true,"type":"string"},"pageToken":{"description":"A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results).","type":"string"},"queryId":{"description":"Auto-generated ID for the query.","type":"string"},"rows":{"description":"An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableRow"}},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"sessionInfo":{"$ref":"#/components/schemas/bigquery_v2_SessionInfo"},"startTime":{"description":"Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE.","format":"int64","readOnly":true,"type":"string"},"statementType":{"description":"Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement.","readOnly":true,"type":"string"},"totalBytesBilled":{"description":"Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.","format":"int64","readOnly":true,"type":"string"},"totalBytesProcessed":{"description":"The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.","format":"int64","type":"string"},"totalRows":{"description":"The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.","format":"uint64","type":"string"},"totalSlotMs":{"description":"Output only. Number of slot ms the user is actually billed for.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_QueryTimelineSample":{"description":"Summary of the state of query execution at a given time.","type":"object","properties":{"activeUnits":{"description":"Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.","format":"int64","type":"string"},"completedUnits":{"description":"Total parallel units of work completed by this query.","format":"int64","type":"string"},"elapsedMs":{"description":"Milliseconds elapsed since the start of query execution.","format":"int64","type":"string"},"estimatedRunnableUnits":{"description":"Units of work that can be scheduled immediately. Providing additional slots for these units of work will accelerate the query, if no other query in the reservation needs additional slots.","format":"int64","type":"string"},"pendingUnits":{"description":"Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.","format":"int64","type":"string"},"shuffleRamUsageRatio":{"description":"Total shuffle usage ratio in shuffle RAM per reservation of this query. This will be provided for reservation customers only.","format":"double","type":"number"},"totalSlotMs":{"description":"Cumulative slot-ms consumed by the query.","format":"int64","type":"string"}}},"bigquery_v2_RangePartitioning":{"type":"object","properties":{"field":{"description":"Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED.","type":"string"},"range":{"description":"[Experimental] Defines the ranges for range partitioning.","type":"object","properties":{"end":{"description":"[Experimental] The end of range partitioning, exclusive.","format":"int64","type":"string"},"interval":{"description":"[Experimental] The width of each interval.","format":"int64","type":"string"},"start":{"description":"[Experimental] The start of range partitioning, inclusive.","format":"int64","type":"string"}}}}},"bigquery_v2_RangeValue":{"description":"Represents the value of a range.","type":"object","properties":{"end":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"},"start":{"$ref":"#/components/schemas/bigquery_v2_QueryParameterValue"}}},"bigquery_v2_RankingMetrics":{"description":"Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit.","type":"object","properties":{"averageRank":{"description":"Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.","format":"double","type":"number"},"meanAveragePrecision":{"description":"Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.","format":"double","type":"number"},"meanSquaredError":{"description":"Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.","format":"double","type":"number"},"normalizedDiscountedCumulativeGain":{"description":"A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.","format":"double","type":"number"}}},"bigquery_v2_RegressionMetrics":{"description":"Evaluation metrics for regression and explicit feedback type matrix factorization models.","type":"object","properties":{"meanAbsoluteError":{"description":"Mean absolute error.","format":"double","type":"number"},"meanSquaredError":{"description":"Mean squared error.","format":"double","type":"number"},"meanSquaredLogError":{"description":"Mean squared log error.","format":"double","type":"number"},"medianAbsoluteError":{"description":"Median absolute error.","format":"double","type":"number"},"rSquared":{"description":"R^2 score. This corresponds to r2_score in ML.EVALUATE.","format":"double","type":"number"}}},"bigquery_v2_RemoteFunctionOptions":{"description":"Options for a remote user-defined function.","type":"object","properties":{"connection":{"description":"Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. Format: ```\"projects/{projectId}/locations/{locationId}/connections/{connectionId}\"```","type":"string"},"endpoint":{"description":"Endpoint of the user-provided remote service, e.g. ```https://us-east1-my_gcf_project.cloudfunctions.net/remote_add```","type":"string"},"maxBatchingRows":{"description":"Max number of rows in each batch sent to the remote service. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.","format":"int64","type":"string"},"userDefinedContext":{"description":"User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service. The total number of bytes of keys and values must be less than 8KB.","type":"object","additionalProperties":{"type":"string"}}}},"bigquery_v2_RemoteModelInfo":{"description":"Remote Model Info","type":"object","properties":{"connection":{"description":"Output only. Fully qualified name of the user-provided connection object of the remote model. Format: ```\"projects/{project_id}/locations/{location_id}/connections/{connection_id}\"```","readOnly":true,"type":"string"},"endpoint":{"description":"Output only. The endpoint for remote model.","readOnly":true,"type":"string"},"maxBatchingRows":{"description":"Output only. Max number of rows in each batch sent to the remote service. If unset, the number of rows in each batch is set dynamically.","format":"int64","readOnly":true,"type":"string"},"remoteModelVersion":{"description":"Output only. The model version for LLM.","readOnly":true,"type":"string"},"remoteServiceType":{"description":"Output only. The remote service type for remote model.","readOnly":true,"enum":["REMOTE_SERVICE_TYPE_UNSPECIFIED","CLOUD_AI_TRANSLATE_V3","CLOUD_AI_VISION_V1","CLOUD_AI_NATURAL_LANGUAGE_V1","CLOUD_AI_SPEECH_TO_TEXT_V2"],"type":"string"},"speechRecognizer":{"description":"Output only. The name of the speech recognizer to use for speech recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. Customers can specify this field at model creation. If not specified, a default recognizer `projects/{model project}/locations/global/recognizers/_` will be used. See more details at [recognizers](https://cloud.google.com/speech-to-text/v2/docs/reference/rest/v2/projects.locations.recognizers)","readOnly":true,"type":"string"}}},"bigquery_v2_RestrictionConfig":{"type":"object","properties":{"type":{"description":"Output only. Specifies the type of dataset/table restriction.","readOnly":true,"enum":["RESTRICTION_TYPE_UNSPECIFIED","RESTRICTED_DATA_EGRESS"],"type":"string"}}},"bigquery_v2_Routine":{"description":"A user-defined function or a stored procedure.","type":"object","properties":{"arguments":{"description":"Optional.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Argument"}},"buildStatus":{"$ref":"#/components/schemas/bigquery_v2_RoutineBuildStatus"},"creationTime":{"description":"Output only. The time when this routine was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"dataGovernanceType":{"description":"Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask).","enum":["DATA_GOVERNANCE_TYPE_UNSPECIFIED","DATA_MASKING"],"type":"string"},"definitionBody":{"description":"Required. The body of the routine. For functions, this is the expression in the AS clause. If `language = \"SQL\"`, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, \"\\n\", y))` The definition_body is `concat(x, \"\\n\", y)` (\\n is not replaced with linebreak). If `language=\"JAVASCRIPT\"`, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return \"\\n\";\\n'` The definition_body is `return \"\\n\";\\n` Note that both \\n are replaced with linebreaks. If `definition_body` references another routine, then that routine must be fully qualified with its project ID.","type":"string"},"description":{"description":"Optional. The description of the routine, if defined.","type":"string"},"determinismLevel":{"description":"Optional. The determinism level of the JavaScript UDF, if defined.","enum":["DETERMINISM_LEVEL_UNSPECIFIED","DETERMINISTIC","NOT_DETERMINISTIC"],"type":"string"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"externalRuntimeOptions":{"$ref":"#/components/schemas/bigquery_v2_ExternalRuntimeOptions"},"importedLibraries":{"description":"Optional. If language = \"JAVASCRIPT\", this field stores the path of the imported JAVASCRIPT libraries.","type":"array","items":{"type":"string"}},"language":{"description":"Optional. Defaults to \"SQL\" if remote_function_options field is absent, not set otherwise.","enum":["LANGUAGE_UNSPECIFIED","SQL","JAVASCRIPT","PYTHON","JAVA","SCALA"],"type":"string"},"lastModifiedTime":{"description":"Output only. The time when this routine was last modified, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"pythonOptions":{"$ref":"#/components/schemas/bigquery_v2_PythonOptions"},"remoteFunctionOptions":{"$ref":"#/components/schemas/bigquery_v2_RemoteFunctionOptions"},"returnTableType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlTableType"},"returnType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"routineReference":{"$ref":"#/components/schemas/bigquery_v2_RoutineReference"},"routineType":{"description":"Required. The type of routine.","enum":["ROUTINE_TYPE_UNSPECIFIED","SCALAR_FUNCTION","PROCEDURE","TABLE_VALUED_FUNCTION","AGGREGATE_FUNCTION"],"type":"string"},"securityMode":{"description":"Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.","enum":["SECURITY_MODE_UNSPECIFIED","DEFINER","INVOKER"],"type":"string"},"sparkOptions":{"$ref":"#/components/schemas/bigquery_v2_SparkOptions"},"strictMode":{"description":"Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If `strictMode` is set to `TRUE`, the procedure body is further checked for errors such as non-existent tables or columns. The `CREATE PROCEDURE` statement fails if the body fails any of these checks. If `strictMode` is set to `FALSE`, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify `strictMode=FALSE` to avoid non-existent procedure errors during validation. Default value is `TRUE`.","type":"boolean"}}},"bigquery_v2_RoutineBuildStatus":{"description":"The status of a routine build.","type":"object","properties":{"buildDuration":{"description":"Output only. The time taken for the image build. Populated only after the build succeeds or fails.","format":"google-duration","readOnly":true,"type":"string"},"buildState":{"description":"Output only. The current build state of the routine.","readOnly":true,"enum":["BUILD_STATE_UNSPECIFIED","IN_PROGRESS","SUCCEEDED","FAILED"],"type":"string"},"buildStateUpdateTime":{"description":"Output only. The time when the build state was updated last.","format":"google-datetime","readOnly":true,"type":"string"},"errorResult":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"imageSizeBytes":{"description":"Output only. The size of the image in bytes. Populated only after the build succeeds.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_RoutineReference":{"description":"Id path of a routine.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this routine.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this routine.","type":"string"},"routineId":{"description":"Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.","type":"string"}}},"bigquery_v2_Row":{"description":"A single row in the confusion matrix.","type":"object","properties":{"actualLabel":{"description":"The original label of this row.","type":"string"},"entries":{"description":"Info describing predicted label distribution.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_Entry"}}}},"bigquery_v2_RowAccessPolicy":{"description":"Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.","type":"object","properties":{"creationTime":{"description":"Output only. The time when this row access policy was created, in milliseconds since the epoch.","format":"google-datetime","readOnly":true,"type":"string"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"filterPredicate":{"description":"Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0","type":"string"},"grantees":{"description":"Optional. Input only. The optional list of iam_member users or groups that specifies the initial members that the row-level access policy should be created with. grantees types: - \"user:alice@example.com\": An email address that represents a specific Google account. - \"serviceAccount:my-other-app@appspot.gserviceaccount.com\": An email address that represents a service account. - \"group:admins@example.com\": An email address that represents a Google group. - \"domain:example.com\":The Google Workspace domain (primary) that represents all the users of that domain. - \"allAuthenticatedUsers\": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included. - \"allUsers\":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.","type":"array","items":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The time when this row access policy was last modified, in milliseconds since the epoch.","format":"google-datetime","readOnly":true,"type":"string"},"rowAccessPolicyReference":{"$ref":"#/components/schemas/bigquery_v2_RowAccessPolicyReference"}}},"bigquery_v2_RowAccessPolicyReference":{"description":"Id path of a row access policy.","type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this row access policy.","type":"string"},"policyId":{"description":"Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this row access policy.","type":"string"},"tableId":{"description":"Required. The ID of the table containing this row access policy.","type":"string"}}},"bigquery_v2_RowLevelSecurityStatistics":{"description":"Statistics for row-level security.","type":"object","properties":{"rowLevelSecurityApplied":{"description":"Whether any accessed data was protected by row access policies.","type":"boolean"}}},"bigquery_v2_ScriptOptions":{"description":"Options related to script execution.","type":"object","properties":{"keyResultStatement":{"description":"Determines which statement in the script represents the \"key result\", used to populate the schema and query results of the script job. Default is LAST.","enum":["KEY_RESULT_STATEMENT_KIND_UNSPECIFIED","LAST","FIRST_SELECT"],"type":"string"},"statementByteBudget":{"description":"Limit on the number of bytes billed per statement. Exceeding this budget results in an error.","format":"int64","type":"string"},"statementTimeoutMs":{"description":"Timeout period for each statement in a script.","format":"int64","type":"string"}}},"bigquery_v2_ScriptStackFrame":{"description":"Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a \";\", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab \"snaps\" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.","type":"object","properties":{"endColumn":{"description":"Output only. One-based end column.","format":"int32","readOnly":true,"type":"integer"},"endLine":{"description":"Output only. One-based end line.","format":"int32","readOnly":true,"type":"integer"},"procedureId":{"description":"Output only. Name of the active procedure, empty if in a top-level script.","readOnly":true,"type":"string"},"startColumn":{"description":"Output only. One-based start column.","format":"int32","readOnly":true,"type":"integer"},"startLine":{"description":"Output only. One-based start line.","format":"int32","readOnly":true,"type":"integer"},"text":{"description":"Output only. Text of the current statement/expression.","readOnly":true,"type":"string"}}},"bigquery_v2_ScriptStatistics":{"description":"Job statistics specific to the child job of a script.","type":"object","properties":{"evaluationKind":{"description":"Whether this child job was a statement or expression.","enum":["EVALUATION_KIND_UNSPECIFIED","STATEMENT","EXPRESSION"],"type":"string"},"stackFrames":{"description":"Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ScriptStackFrame"}}}},"bigquery_v2_SearchStatistics":{"description":"Statistics for a search query. Populated as part of JobStatistics2.","type":"object","properties":{"indexPruningStats":{"description":"Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IndexPruningStats"}},"indexUnusedReasons":{"description":"When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IndexUnusedReason"}},"indexUsageMode":{"description":"Specifies the index usage mode for the query.","enum":["INDEX_USAGE_MODE_UNSPECIFIED","UNUSED","PARTIALLY_USED","FULLY_USED"],"type":"string"}}},"bigquery_v2_SecureContext":{"description":"A set of key-value pairs representing the secure context.","type":"object","properties":{"secureParameterEntries":{"description":"Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query.","type":"object","additionalProperties":{"description":"Properties of the object."}}}},"bigquery_v2_SerDeInfo":{"description":"Serializer and deserializer information.","type":"object","properties":{"name":{"description":"Optional. Name of the SerDe. The maximum length is 256 characters.","type":"string"},"parameters":{"description":"Optional. Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib.","type":"object","additionalProperties":{"type":"string"}},"serializationLibrary":{"description":"Required. Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters.","type":"string"}}},"bigquery_v2_SessionInfo":{"description":"[Preview] Information related to sessions.","type":"object","properties":{"sessionId":{"description":"Output only. The id of the session.","readOnly":true,"type":"string"}}},"bigquery_v2_SetIamPolicyRequest":{"description":"Request message for `SetIamPolicy` method.","type":"object","properties":{"policy":{"$ref":"#/components/schemas/bigquery_v2_Policy"},"updateMask":{"description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`","format":"google-fieldmask","type":"string"}}},"bigquery_v2_SkewSource":{"description":"Details about source stages which produce skewed data.","type":"object","properties":{"outputBytesMax":{"description":"Output only. Max partition output size (in bytes) for this stage.","format":"int64","readOnly":true,"type":"string"},"outputBytesMedian":{"description":"Output only. Median partition output size (in bytes) for this stage.","format":"int64","readOnly":true,"type":"string"},"outputBytesP95":{"description":"Output only. 95-th percentile of partition output size (in bytes) for this stage.","format":"int64","readOnly":true,"type":"string"},"stageId":{"description":"Output only. Stage id of the skew source stage.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_SnapshotDefinition":{"description":"Information about base table and snapshot time of the snapshot.","type":"object","properties":{"baseTableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"snapshotTime":{"description":"Required. The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.","format":"date-time","type":"string"}}},"bigquery_v2_SparkLoggingInfo":{"description":"Spark job logs can be filtered by these fields in Cloud Logging.","type":"object","properties":{"projectId":{"description":"Output only. Project ID where the Spark logs were written.","readOnly":true,"type":"string"},"resourceType":{"description":"Output only. Resource type used for logging.","readOnly":true,"type":"string"}}},"bigquery_v2_SparkOptions":{"description":"Options for a user-defined Spark routine.","type":"object","properties":{"archiveUris":{"description":"Archive files to be extracted into the working directory of each executor. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"connection":{"description":"Fully qualified name of the user-provided Spark connection object. Format: ```\"projects/{project_id}/locations/{location_id}/connections/{connection_id}\"```","type":"string"},"containerImage":{"description":"Custom container image for the runtime environment.","type":"string"},"fileUris":{"description":"Files to be placed in the working directory of each executor. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"jarUris":{"description":"JARs to include on the driver and executor CLASSPATH. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"mainClass":{"description":"The fully qualified name of a class in jar_uris, for example, com.example.wordcount. Exactly one of main_class and main_jar_uri field should be set for Java/Scala language type.","type":"string"},"mainFileUri":{"description":"The main file/jar URI of the Spark application. Exactly one of the definition_body field and the main_file_uri field must be set for Python. Exactly one of main_class and main_file_uri field should be set for Java/Scala language type.","type":"string"},"properties":{"description":"Configuration properties as a set of key/value pairs, which will be passed on to the Spark application. For more information, see [Apache Spark](https://spark.apache.org/docs/latest/index.html) and the [procedure option list](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#procedure_option_list).","type":"object","additionalProperties":{"type":"string"}},"pyFileUris":{"description":"Python files to be placed on the PYTHONPATH for PySpark application. Supported file types: `.py`, `.egg`, and `.zip`. For more information about Apache Spark, see [Apache Spark](https://spark.apache.org/docs/latest/index.html).","type":"array","items":{"type":"string"}},"runtimeVersion":{"description":"Runtime version. If not specified, the default runtime version is used.","type":"string"}}},"bigquery_v2_SparkStatistics":{"description":"Statistics for a BigSpark query. Populated as part of JobStatistics2","type":"object","properties":{"endpoints":{"description":"Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI.","readOnly":true,"type":"object","additionalProperties":{"type":"string"}},"gcsStagingBucket":{"description":"Output only. The Google Cloud Storage bucket that is used as the default file system by the Spark application. This field is only filled when the Spark procedure uses the invoker security mode. The `gcsStagingBucket` bucket is inferred from the `@@spark_proc_properties.staging_bucket` system variable (if it is provided). Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]`","readOnly":true,"type":"string"},"kmsKeyName":{"description":"Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses the invoker security mode, the Cloud KMS encryption key is either inferred from the provided system variable, `@@spark_proc_properties.kms_key_name`, or the default key of the BigQuery job's project (if the CMEK organization policy is enforced). Otherwise, the Cloud KMS key is either inferred from the Spark connection associated with the procedure (if it is provided), or from the default key of the Spark connection's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]`","readOnly":true,"type":"string"},"loggingInfo":{"$ref":"#/components/schemas/bigquery_v2_SparkLoggingInfo"},"sparkJobId":{"description":"Output only. Spark job ID if a Spark job is created successfully.","readOnly":true,"type":"string"},"sparkJobLocation":{"description":"Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region.","readOnly":true,"type":"string"}}},"bigquery_v2_StagePerformanceChangeInsight":{"description":"Performance insights compared to the previous executions for a specific stage.","type":"object","properties":{"inputDataChange":{"$ref":"#/components/schemas/bigquery_v2_InputDataChange"},"stageId":{"description":"Output only. The stage id that the insight mapped to.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_StagePerformanceStandaloneInsight":{"description":"Standalone performance insights for a specific stage.","type":"object","properties":{"biEngineReasons":{"description":"Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_BiEngineReason"}},"highCardinalityJoins":{"description":"Output only. High cardinality joins in the stage.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_HighCardinalityJoin"}},"insufficientShuffleQuota":{"description":"Output only. True if the stage has insufficient shuffle quota.","readOnly":true,"type":"boolean"},"partitionSkew":{"$ref":"#/components/schemas/bigquery_v2_PartitionSkew"},"slotContention":{"description":"Output only. True if the stage has a slot contention issue.","readOnly":true,"type":"boolean"},"stageId":{"description":"Output only. The stage id that the insight mapped to.","format":"int64","readOnly":true,"type":"string"}}},"bigquery_v2_StandardSqlDataType":{"description":"The data type of a variable such as a function argument. Examples include: * INT64: `{\"typeKind\": \"INT64\"}` * ARRAY: { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"STRING\"} } * STRUCT>: { \"typeKind\": \"STRUCT\", \"structType\": { \"fields\": [ { \"name\": \"x\", \"type\": {\"typeKind\": \"STRING\"} }, { \"name\": \"y\", \"type\": { \"typeKind\": \"ARRAY\", \"arrayElementType\": {\"typeKind\": \"DATE\"} } } ] } } * RANGE: { \"typeKind\": \"RANGE\", \"rangeElementType\": {\"typeKind\": \"DATE\"} }","type":"object","properties":{"arrayElementType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"rangeElementType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"},"structType":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlStructType"},"typeKind":{"description":"Required. The top level type of this field. Can be any GoogleSQL data type (e.g., \"INT64\", \"DATE\", \"ARRAY\").","enum":["TYPE_KIND_UNSPECIFIED","INT64","BOOL","FLOAT64","STRING","BYTES","TIMESTAMP","DATE","TIME","DATETIME","INTERVAL","GEOGRAPHY","NUMERIC","BIGNUMERIC","JSON","ARRAY","STRUCT","RANGE","UUID"],"type":"string"}}},"bigquery_v2_StandardSqlField":{"description":"A field or a column.","type":"object","properties":{"name":{"description":"Optional. The name of this field. Can be absent for struct fields.","type":"string"},"type":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"}}},"bigquery_v2_StandardSqlStructType":{"description":"The representation of a SQL STRUCT type.","type":"object","properties":{"fields":{"description":"Fields within the struct.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}}}},"bigquery_v2_StandardSqlTableType":{"description":"A table type","type":"object","properties":{"columns":{"description":"The columns in this table type","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlField"}}}},"bigquery_v2_StorageDescriptor":{"description":"Contains information about how a table's data is stored and accessed by open source query engines.","type":"object","properties":{"inputFormat":{"description":"Optional. Specifies the fully qualified class name of the InputFormat (e.g. \"org.apache.hadoop.hive.ql.io.orc.OrcInputFormat\"). The maximum length is 128 characters.","type":"string"},"locationUri":{"description":"Optional. The physical location of the table (e.g. `gs://spark-dataproc-data/pangea-data/case_sensitive/` or `gs://spark-dataproc-data/pangea-data/*`). The maximum length is 2056 bytes.","type":"string"},"outputFormat":{"description":"Optional. Specifies the fully qualified class name of the OutputFormat (e.g. \"org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat\"). The maximum length is 128 characters.","type":"string"},"serdeInfo":{"$ref":"#/components/schemas/bigquery_v2_SerDeInfo"}}},"bigquery_v2_StoredColumnsUnusedReason":{"description":"If the stored column was not used, explain why.","type":"object","properties":{"code":{"description":"Specifies the high-level reason for the unused scenario, each reason must have a code associated.","enum":["CODE_UNSPECIFIED","STORED_COLUMNS_COVER_INSUFFICIENT","BASE_TABLE_HAS_RLS","BASE_TABLE_HAS_CLS","UNSUPPORTED_PREFILTER","INTERNAL_ERROR","OTHER_REASON"],"type":"string"},"message":{"description":"Specifies the detailed description for the scenario.","type":"string"},"uncoveredColumns":{"description":"Specifies which columns were not covered by the stored columns for the specified code up to 20 columns. This is populated when the code is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS.","type":"array","items":{"type":"string"}}}},"bigquery_v2_StoredColumnsUsage":{"description":"Indicates the stored columns usage in the query.","type":"object","properties":{"baseTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"isQueryAccelerated":{"description":"Specifies whether the query was accelerated with stored columns.","type":"boolean"},"storedColumnsUnusedReasons":{"description":"If stored columns were not used, explain why.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StoredColumnsUnusedReason"}}}},"bigquery_v2_Streamingbuffer":{"type":"object","properties":{"estimatedBytes":{"description":"Output only. A lower-bound estimate of the number of bytes currently in the streaming buffer.","format":"uint64","readOnly":true,"type":"string"},"estimatedRows":{"description":"Output only. A lower-bound estimate of the number of rows currently in the streaming buffer.","format":"uint64","readOnly":true,"type":"string"},"oldestEntryTime":{"description":"Output only. Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.","format":"uint64","readOnly":true,"type":"string"}}},"bigquery_v2_StringHparamSearchSpace":{"description":"Search space for string and enum.","type":"object","properties":{"candidates":{"description":"Canididates for the string or enum parameter in lower case.","type":"array","items":{"type":"string"}}}},"bigquery_v2_SystemVariables":{"description":"System variables given to a query.","type":"object","properties":{"types":{"description":"Output only. Data type for each system variable.","readOnly":true,"type":"object","additionalProperties":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"}},"values":{"description":"Output only. Value for each system variable.","readOnly":true,"type":"object","additionalProperties":{"description":"Properties of the object."}}}},"bigquery_v2_Table":{"type":"object","properties":{"biglakeConfiguration":{"$ref":"#/components/schemas/bigquery_v2_BigLakeConfiguration"},"cloneDefinition":{"$ref":"#/components/schemas/bigquery_v2_CloneDefinition"},"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"creationTime":{"description":"Output only. The time when this table was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"defaultCollation":{"description":"Optional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.","type":"string"},"defaultRoundingMode":{"description":"Optional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn't affect existing fields.","enum":["ROUNDING_MODE_UNSPECIFIED","ROUND_HALF_AWAY_FROM_ZERO","ROUND_HALF_EVEN"],"type":"string"},"description":{"description":"Optional. A user-friendly description of this table.","type":"string"},"encryptionConfiguration":{"$ref":"#/components/schemas/bigquery_v2_EncryptionConfiguration"},"etag":{"description":"Output only. A hash of this resource.","readOnly":true,"type":"string"},"expirationTime":{"description":"Optional. The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.","format":"int64","type":"string"},"externalCatalogTableOptions":{"$ref":"#/components/schemas/bigquery_v2_ExternalCatalogTableOptions"},"externalDataConfiguration":{"$ref":"#/components/schemas/bigquery_v2_ExternalDataConfiguration"},"friendlyName":{"description":"Optional. A descriptive name for this table.","type":"string"},"id":{"description":"Output only. An opaque ID uniquely identifying the table.","readOnly":true,"type":"string"},"kind":{"description":"The type of resource ID.","default":"bigquery#table","type":"string"},"labels":{"description":"The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.","type":"object","additionalProperties":{"type":"string"}},"lastModifiedTime":{"description":"Output only. The time when this table was last modified, in milliseconds since the epoch.","format":"uint64","readOnly":true,"type":"string"},"location":{"description":"Output only. The geographic location where the table resides. This value is inherited from the dataset.","readOnly":true,"type":"string"},"managedTableType":{"description":"Optional. If set, overrides the default managed table type configured in the dataset.","enum":["MANAGED_TABLE_TYPE_UNSPECIFIED","NATIVE","BIGLAKE"],"type":"string"},"materializedView":{"$ref":"#/components/schemas/bigquery_v2_MaterializedViewDefinition"},"materializedViewStatus":{"$ref":"#/components/schemas/bigquery_v2_MaterializedViewStatus"},"maxStaleness":{"description":"Optional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type.","type":"string"},"model":{"$ref":"#/components/schemas/bigquery_v2_ModelDefinition"},"numActiveLogicalBytes":{"description":"Output only. Number of logical bytes that are less than 90 days old.","format":"int64","readOnly":true,"type":"string"},"numActivePhysicalBytes":{"description":"Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numBytes":{"description":"Output only. The size of this table in logical bytes, excluding any data in the streaming buffer.","format":"int64","readOnly":true,"type":"string"},"numCurrentPhysicalBytes":{"description":"Output only. Number of physical bytes used by current live data storage. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numLongTermBytes":{"description":"Output only. The number of logical bytes in the table that are considered \"long-term storage\".","format":"int64","readOnly":true,"type":"string"},"numLongTermLogicalBytes":{"description":"Output only. Number of logical bytes that are more than 90 days old.","format":"int64","readOnly":true,"type":"string"},"numLongTermPhysicalBytes":{"description":"Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numPartitions":{"description":"Output only. The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numPhysicalBytes":{"description":"Output only. The physical size of this table in bytes. This includes storage used for time travel.","format":"int64","readOnly":true,"type":"string"},"numRows":{"description":"Output only. The number of rows of data in this table, excluding any data in the streaming buffer.","format":"uint64","readOnly":true,"type":"string"},"numTimeTravelPhysicalBytes":{"description":"Output only. Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"numTotalLogicalBytes":{"description":"Output only. Total number of logical bytes in the table or materialized view.","format":"int64","readOnly":true,"type":"string"},"numTotalPhysicalBytes":{"description":"Output only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.","format":"int64","readOnly":true,"type":"string"},"partitionDefinition":{"$ref":"#/components/schemas/bigquery_v2_PartitioningDefinition"},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"replicas":{"description":"Optional. Output only. Table references of all replicas currently active on the table.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}},"requirePartitionFilter":{"description":"Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.","default":false,"type":"boolean"},"resourceTags":{"description":"[Optional] The tags associated with this table. Tag keys are globally unique. See additional information on [tags](https://cloud.google.com/iam/docs/tags-access-control#definitions). An object containing a list of \"key\": value pairs. The key is the namespaced friendly name of the tag key, e.g. \"12345/environment\" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. \"production\".","type":"object","additionalProperties":{"type":"string"}},"restrictions":{"$ref":"#/components/schemas/bigquery_v2_RestrictionConfig"},"schema":{"$ref":"#/components/schemas/bigquery_v2_TableSchema"},"selfLink":{"description":"Output only. A URL that can be used to access this resource again.","readOnly":true,"type":"string"},"snapshotDefinition":{"$ref":"#/components/schemas/bigquery_v2_SnapshotDefinition"},"streamingBuffer":{"$ref":"#/components/schemas/bigquery_v2_Streamingbuffer"},"tableConstraints":{"$ref":"#/components/schemas/bigquery_v2_TableConstraints"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"tableReplicationInfo":{"$ref":"#/components/schemas/bigquery_v2_TableReplicationInfo"},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"type":{"description":"Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](https://cloud.google.com/bigquery/docs/table-snapshots-intro). The default value is `TABLE`.","readOnly":true,"type":"string"},"view":{"$ref":"#/components/schemas/bigquery_v2_ViewDefinition"}}},"bigquery_v2_TableCell":{"type":"object","properties":{"v":{}}},"bigquery_v2_TableChangeInsight":{"description":"Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table.","type":"object","properties":{"metadataCacheNotUsedButUsedPreviously":{"description":"Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash.","readOnly":true,"type":"boolean"},"metadataCacheStalenessInsight":{"$ref":"#/components/schemas/bigquery_v2_MetadataCacheStalenessInsight"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_TableConstraints":{"description":"The TableConstraints defines the primary key and foreign key.","type":"object","properties":{"foreignKeys":{"description":"Optional. Present only if the table has a foreign key. The foreign key is not enforced.","type":"array","items":{"description":"Represents a foreign key constraint on a table's columns.","type":"object","properties":{"columnReferences":{"description":"Required. The columns that compose the foreign key.","type":"array","items":{"description":"The pair of the foreign key column and primary key column.","type":"object","properties":{"referencedColumn":{"description":"Required. The column in the primary key that are referenced by the referencing_column.","type":"string"},"referencingColumn":{"description":"Required. The column that composes the foreign key.","type":"string"}}}},"name":{"description":"Optional. Set only if the foreign key constraint is named.","type":"string"},"referencedTable":{"type":"object","properties":{"datasetId":{"type":"string"},"projectId":{"type":"string"},"tableId":{"type":"string"}}}}}},"primaryKey":{"description":"Represents the primary key constraint on a table's columns.","type":"object","properties":{"columns":{"description":"Required. The columns that are composed of the primary key constraint.","type":"array","items":{"type":"string"}}}}}},"bigquery_v2_TableDataInsertAllRequest":{"description":"Request for sending a single streaming insert.","type":"object","properties":{"ignoreUnknownValues":{"description":"Optional. Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.","type":"boolean"},"kind":{"description":"Optional. The resource type of the response. The value is not checked at the backend. Historically, it has been set to \"bigquery#tableDataInsertAllRequest\" but you are not required to set it.","default":"bigquery#tableDataInsertAllRequest","type":"string"},"rows":{"type":"array","items":{"description":"Data for a single insertion row.","type":"object","properties":{"insertId":{"description":"Insertion ID for best-effort deduplication. This feature is not recommended, and users seeking stronger insertion semantics are encouraged to use other mechanisms such as the BigQuery Write API.","type":"string"},"json":{"$ref":"#/components/schemas/bigquery_v2_JsonObject"}}}},"skipInvalidRows":{"description":"Optional. Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.","type":"boolean"},"templateSuffix":{"description":"Optional. If specified, treats the destination table as a base template, and inserts the rows into an instance table named \"{destination}{templateSuffix}\". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.","type":"string"},"traceId":{"description":"Optional. Unique request trace id. Used for debugging purposes only. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended.","type":"string"}}},"bigquery_v2_TableDataInsertAllResponse":{"description":"Describes the format of a streaming insert response.","type":"object","properties":{"insertErrors":{"description":"Describes specific errors encountered while processing the request.","type":"array","items":{"description":"Error details about a single row's insertion.","type":"object","properties":{"errors":{"description":"Error information for the row indicated by the index property.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"}},"index":{"description":"The index of the row that error applies to.","format":"uint32","type":"integer"}}}},"kind":{"description":"Returns \"bigquery#tableDataInsertAllResponse\".","default":"bigquery#tableDataInsertAllResponse","type":"string"}}},"bigquery_v2_TableDataList":{"type":"object","properties":{"etag":{"description":"A hash of this page of results.","type":"string"},"kind":{"description":"The resource type of the response.","default":"bigquery#tableDataList","type":"string"},"pageToken":{"description":"A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.","type":"string"},"rows":{"description":"Rows of results.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableRow"}},"totalRows":{"description":"Total rows of the entire table. In order to show default value 0 we have to present it as string.","format":"int64","type":"string"}}},"bigquery_v2_TableFieldSchema":{"description":"A field in TableSchema","type":"object","properties":{"categories":{"description":"Deprecated.","type":"object","properties":{"names":{"description":"Deprecated.","type":"array","items":{"type":"string"}}}},"collation":{"description":"Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.","type":"string"},"dataGovernanceTagsInfo":{"description":"Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: * **Precedence**: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. * **Patching behavior**: Describes how this field behaves during a `Table.patch` schema update: * **Unset**: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. * **Empty Field**: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This removes all tags from the column. * **Updating tags**: To replace an existing tag, send the field with the new tag.","type":"object","properties":{"dataGovernanceTags":{"description":"Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"parent-id/pii\" where parent-id is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"sensitive\". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: \"parent-id/pii\": \"sensitive\", \"myProject/cost_center\": \"sales\"","type":"object","additionalProperties":{"type":"string"}}}},"dataPolicies":{"description":"Optional. Data policies attached to this field, used for field-level access control.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_DataPolicyOption"}},"dataPolicyList":{"$ref":"#/components/schemas/bigquery_v2_DataPolicyList"},"defaultValueExpression":{"description":"Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.","type":"string"},"description":{"description":"Optional. The field description. The maximum length is 1,024 characters.","type":"string"},"fields":{"description":"Optional. Describes the nested schema fields if the type property is set to RECORD.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableFieldSchema"}},"foreignTypeDefinition":{"description":"Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.","type":"string"},"generatedColumn":{"$ref":"#/components/schemas/bigquery_v2_GeneratedColumn"},"maxLength":{"description":"Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = \"STRING\", then max_length represents the maximum UTF-8 length of strings in this field. If type = \"BYTES\", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ \"STRING\" and ≠ \"BYTES\".","format":"int64","type":"string"},"mode":{"description":"Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.","type":"string"},"name":{"description":"Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.","type":"string"},"policyTags":{"description":"Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.","type":"object","properties":{"names":{"description":"A list of policy tag resource names. For example, \"projects/1/locations/eu/taxonomies/2/policyTags/3\". At most 1 policy tag is currently allowed.","type":"array","items":{"type":"string"}}}},"precision":{"description":"Optional. Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ \"NUMERIC\" and ≠ \"BIGNUMERIC\". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: * Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] * Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: * If type = \"NUMERIC\": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. * If type = \"BIGNUMERIC\": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): * If type = \"NUMERIC\": 1 ≤ precision ≤ 29. * If type = \"BIGNUMERIC\": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.","format":"int64","type":"string"},"rangeElementType":{"description":"Represents the type of a field element.","type":"object","properties":{"type":{"description":"Required. The type of a field element. For more information, see TableFieldSchema.type.","type":"string"}}},"roundingMode":{"description":"Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.","enum":["ROUNDING_MODE_UNSPECIFIED","ROUND_HALF_AWAY_FROM_ZERO","ROUND_HALF_EVEN"],"type":"string"},"scale":{"description":"Optional. See documentation for precision.","format":"int64","type":"string"},"timestampPrecision":{"description":"Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)","format":"int64","default":"6","type":"string"},"type":{"description":"Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema.","type":"string"}}},"bigquery_v2_TableList":{"description":"Partial projection of the metadata for a given table in a list response.","type":"object","properties":{"etag":{"description":"A hash of this page of results.","type":"string"},"kind":{"description":"The type of list.","default":"bigquery#tableList","type":"string"},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"},"tables":{"description":"Tables in the requested dataset.","type":"array","items":{"type":"object","properties":{"clustering":{"$ref":"#/components/schemas/bigquery_v2_Clustering"},"creationTime":{"description":"Output only. The time when this table was created, in milliseconds since the epoch.","format":"int64","readOnly":true,"type":"string"},"expirationTime":{"description":"The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.","format":"int64","type":"string"},"friendlyName":{"description":"The user-friendly name for this table.","type":"string"},"id":{"description":"An opaque ID of the table.","type":"string"},"kind":{"description":"The resource type.","type":"string"},"labels":{"description":"The labels associated with this table. You can use these to organize and group your tables.","type":"object","additionalProperties":{"type":"string"}},"rangePartitioning":{"$ref":"#/components/schemas/bigquery_v2_RangePartitioning"},"requirePartitionFilter":{"description":"Optional. If set to true, queries including this table must specify a partition filter. This filter is used for partition elimination.","default":false,"type":"boolean"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"timePartitioning":{"$ref":"#/components/schemas/bigquery_v2_TimePartitioning"},"type":{"description":"The type of table.","type":"string"},"view":{"description":"Information about a logical view.","type":"object","properties":{"privacyPolicy":{"$ref":"#/components/schemas/bigquery_v2_PrivacyPolicy"},"useLegacySql":{"description":"True if view is defined in legacy SQL dialect, false if in GoogleSQL.","type":"boolean"}}}}}},"totalItems":{"description":"The total number of tables in the dataset.","format":"int32","type":"integer"}}},"bigquery_v2_TableMetadataCacheUsage":{"description":"Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.","type":"object","properties":{"explanation":{"description":"Free form human-readable reason metadata caching was unused for the job.","type":"string"},"pruningStats":{"$ref":"#/components/schemas/bigquery_v2_PruningStats"},"staleness":{"description":"Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).","format":"google-duration","type":"string"},"tableReference":{"$ref":"#/components/schemas/bigquery_v2_TableReference"},"tableType":{"description":"[Table type](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).","type":"string"},"unusedReason":{"description":"Reason for not using metadata caching for the table.","enum":["UNUSED_REASON_UNSPECIFIED","EXCEEDED_MAX_STALENESS","METADATA_CACHING_NOT_ENABLED","OTHER_REASON"],"type":"string"}}},"bigquery_v2_TableReference":{"type":"object","properties":{"datasetId":{"description":"Required. The ID of the dataset containing this table.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this table.","type":"string"},"tableId":{"description":"Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`.","type":"string"}}},"bigquery_v2_TableReplicationInfo":{"description":"Replication info of a table created using `AS REPLICA` DDL like: `CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv`","type":"object","properties":{"replicatedSourceLastRefreshTime":{"description":"Optional. Output only. If source is a materialized view, this field signifies the last refresh time of the source.","format":"int64","readOnly":true,"type":"string"},"replicationError":{"$ref":"#/components/schemas/bigquery_v2_ErrorProto"},"replicationIntervalMs":{"description":"Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied.","format":"int64","type":"string"},"replicationStatus":{"description":"Optional. Output only. Replication status of configured replication.","readOnly":true,"enum":["REPLICATION_STATUS_UNSPECIFIED","ACTIVE","SOURCE_DELETED","PERMISSION_DENIED","UNSUPPORTED_CONFIGURATION"],"type":"string"},"sourceTable":{"$ref":"#/components/schemas/bigquery_v2_TableReference"}}},"bigquery_v2_TableRow":{"type":"object","properties":{"f":{"description":"Represents a single row in the result set, consisting of one or more fields.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableCell"}}}},"bigquery_v2_TableSchema":{"description":"Schema of a table","type":"object","properties":{"fields":{"description":"Describes the fields in a table.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_TableFieldSchema"}},"foreignTypeInfo":{"$ref":"#/components/schemas/bigquery_v2_ForeignTypeInfo"}}},"bigquery_v2_TestIamPermissionsRequest":{"description":"Request message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).","type":"array","items":{"type":"string"}}}},"bigquery_v2_TestIamPermissionsResponse":{"description":"Response message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"A subset of `TestPermissionsRequest.permissions` that the caller is allowed.","type":"array","items":{"type":"string"}}}},"bigquery_v2_TimePartitioning":{"type":"object","properties":{"expirationMs":{"description":"Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.","format":"int64","type":"string"},"field":{"description":"Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.","type":"string"},"requirePartitionFilter":{"description":"If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.","default":false,"type":"boolean"},"type":{"description":"Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.","type":"string"}}},"bigquery_v2_TrainingOptions":{"description":"Options used in model training.","type":"object","properties":{"activationFn":{"description":"Activation function of the neural nets.","type":"string"},"adjustStepChanges":{"description":"If true, detect step changes and make data adjustment in the input time series.","type":"boolean"},"approxGlobalFeatureContrib":{"description":"Whether to use approximate feature contribution method in XGBoost model explanation for global explain.","type":"boolean"},"autoArima":{"description":"Whether to enable auto ARIMA or not.","type":"boolean"},"autoArimaMaxOrder":{"description":"The max value of the sum of non-seasonal p and q.","format":"int64","type":"string"},"autoArimaMinOrder":{"description":"The min value of the sum of non-seasonal p and q.","format":"int64","type":"string"},"autoClassWeights":{"description":"Whether to calculate class weights automatically based on the popularity of each label.","type":"boolean"},"batchSize":{"description":"Batch size for dnn models.","format":"int64","type":"string"},"boosterType":{"description":"Booster type for boosted tree models.","enum":["BOOSTER_TYPE_UNSPECIFIED","GBTREE","DART"],"type":"string"},"budgetHours":{"description":"Budget in hours for AutoML training.","format":"double","type":"number"},"calculatePValues":{"description":"Whether or not p-value test should be computed for this model. Only available for linear and logistic regression models.","type":"boolean"},"categoryEncodingMethod":{"description":"Categorical feature encoding method.","enum":["ENCODING_METHOD_UNSPECIFIED","ONE_HOT_ENCODING","LABEL_ENCODING","DUMMY_ENCODING"],"type":"string"},"cleanSpikesAndDips":{"description":"If true, clean spikes and dips in the input time series.","type":"boolean"},"colorSpace":{"description":"Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace.","enum":["COLOR_SPACE_UNSPECIFIED","RGB","HSV","YIQ","YUV","GRAYSCALE"],"type":"string"},"colsampleBylevel":{"description":"Subsample ratio of columns for each level for boosted tree models.","format":"double","type":"number"},"colsampleBynode":{"description":"Subsample ratio of columns for each node(split) for boosted tree models.","format":"double","type":"number"},"colsampleBytree":{"description":"Subsample ratio of columns when constructing each tree for boosted tree models.","format":"double","type":"number"},"contributionMetric":{"description":"The contribution metric. Applies to contribution analysis models. Allowed formats supported are for summable and summable ratio contribution metrics. These include expressions such as `SUM(x)` or `SUM(x)/SUM(y)`, where x and y are column names from the base table.","type":"string"},"dartNormalizeType":{"description":"Type of normalization algorithm for boosted tree models using dart booster.","enum":["DART_NORMALIZE_TYPE_UNSPECIFIED","TREE","FOREST"],"type":"string"},"dataFrequency":{"description":"The data frequency of a time series.","enum":["DATA_FREQUENCY_UNSPECIFIED","AUTO_FREQUENCY","YEARLY","QUARTERLY","MONTHLY","WEEKLY","DAILY","HOURLY","PER_MINUTE"],"type":"string"},"dataSplitColumn":{"description":"The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data_type_properties","type":"string"},"dataSplitEvalFraction":{"description":"The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.","format":"double","type":"number"},"dataSplitMethod":{"description":"The data split type for training and evaluation, e.g. RANDOM.","enum":["DATA_SPLIT_METHOD_UNSPECIFIED","RANDOM","CUSTOM","SEQUENTIAL","NO_SPLIT","AUTO_SPLIT"],"type":"string"},"decomposeTimeSeries":{"description":"If true, perform decompose time series and save the results.","type":"boolean"},"dimensionIdColumns":{"description":"Optional. Names of the columns to slice on. Applies to contribution analysis models.","type":"array","items":{"type":"string"}},"distanceType":{"description":"Distance type for clustering models.","enum":["DISTANCE_TYPE_UNSPECIFIED","EUCLIDEAN","COSINE"],"type":"string"},"dropout":{"description":"Dropout probability for dnn models.","format":"double","type":"number"},"earlyStop":{"description":"Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.","type":"boolean"},"enableGlobalExplain":{"description":"If true, enable global explanation during training.","type":"boolean"},"endpointIdleTtl":{"description":"The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours.","format":"google-duration","type":"string"},"feedbackType":{"description":"Feedback type that specifies which algorithm to run for matrix factorization.","enum":["FEEDBACK_TYPE_UNSPECIFIED","IMPLICIT","EXPLICIT"],"type":"string"},"fitIntercept":{"description":"Whether the model should include intercept during model training.","type":"boolean"},"forecastLimitLowerBound":{"description":"The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html","format":"double","type":"number"},"forecastLimitUpperBound":{"description":"The forecast limit upper bound that was used during ARIMA model training with limits.","format":"double","type":"number"},"hiddenUnits":{"description":"Hidden units for dnn models.","type":"array","items":{"format":"int64","type":"string"}},"holidayRegion":{"description":"The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.","enum":["HOLIDAY_REGION_UNSPECIFIED","GLOBAL","NA","JAPAC","EMEA","LAC","AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CS","CZ","DE","DK","DZ","EC","EE","EG","ES","FI","FR","GB","GR","HK","HU","ID","IE","IL","IN","IR","IT","JP","KR","LV","MA","MX","MY","NG","NL","NO","NZ","PE","PH","PK","PL","PT","RO","RS","RU","SA","SE","SG","SI","SK","TH","TR","TW","UA","US","VE","VN","ZA"],"type":"string"},"holidayRegions":{"description":"A list of geographical regions that are used for time series modeling.","type":"array","items":{"enum":["HOLIDAY_REGION_UNSPECIFIED","GLOBAL","NA","JAPAC","EMEA","LAC","AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CS","CZ","DE","DK","DZ","EC","EE","EG","ES","FI","FR","GB","GR","HK","HU","ID","IE","IL","IN","IR","IT","JP","KR","LV","MA","MX","MY","NG","NL","NO","NZ","PE","PH","PK","PL","PT","RO","RS","RU","SA","SE","SG","SI","SK","TH","TR","TW","UA","US","VE","VN","ZA"],"type":"string"}},"horizon":{"description":"The number of periods ahead that need to be forecasted.","format":"int64","type":"string"},"hparamTuningObjectives":{"description":"The target evaluation metrics to optimize the hyperparameters for.","type":"array","items":{"enum":["HPARAM_TUNING_OBJECTIVE_UNSPECIFIED","MEAN_ABSOLUTE_ERROR","MEAN_SQUARED_ERROR","MEAN_SQUARED_LOG_ERROR","MEDIAN_ABSOLUTE_ERROR","R_SQUARED","EXPLAINED_VARIANCE","PRECISION","RECALL","ACCURACY","F1_SCORE","LOG_LOSS","ROC_AUC","DAVIES_BOULDIN_INDEX","MEAN_AVERAGE_PRECISION","NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN","AVERAGE_RANK"],"type":"string"}},"huggingFaceModelId":{"description":"The id of a Hugging Face model. For example, `google/gemma-2-2b-it`.","type":"string"},"includeDrift":{"description":"Include drift when fitting an ARIMA model.","type":"boolean"},"initialLearnRate":{"description":"Specifies the initial learning rate for the line search learn rate strategy.","format":"double","type":"number"},"inputLabelColumns":{"description":"Name of input label columns in training data.","type":"array","items":{"type":"string"}},"instanceWeightColumn":{"description":"Name of the instance weight column for training data. This column isn't be used as a feature.","type":"string"},"integratedGradientsNumSteps":{"description":"Number of integral steps for the integrated gradients explain method.","format":"int64","type":"string"},"isTestColumn":{"description":"Name of the column used to determine the rows corresponding to control and test. Applies to contribution analysis models.","type":"string"},"itemColumn":{"description":"Item column specified for matrix factorization models.","type":"string"},"kmeansInitializationColumn":{"description":"The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.","type":"string"},"kmeansInitializationMethod":{"description":"The method used to initialize the centroids for kmeans algorithm.","enum":["KMEANS_INITIALIZATION_METHOD_UNSPECIFIED","RANDOM","CUSTOM","KMEANS_PLUS_PLUS"],"type":"string"},"l1RegActivation":{"description":"L1 regularization coefficient to activations.","format":"double","type":"number"},"l1Regularization":{"description":"L1 regularization coefficient.","format":"double","type":"number"},"l2Regularization":{"description":"L2 regularization coefficient.","format":"double","type":"number"},"labelClassWeights":{"description":"Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.","type":"object","additionalProperties":{"format":"double","type":"number"}},"learnRate":{"description":"Learning rate in training. Used only for iterative training algorithms.","format":"double","type":"number"},"learnRateStrategy":{"description":"The strategy to determine learn rate for the current iteration.","enum":["LEARN_RATE_STRATEGY_UNSPECIFIED","LINE_SEARCH","CONSTANT"],"type":"string"},"lossType":{"description":"Type of loss function used during training run.","enum":["LOSS_TYPE_UNSPECIFIED","MEAN_SQUARED_LOSS","MEAN_LOG_LOSS"],"type":"string"},"machineType":{"description":"The type of the machine used to deploy and serve the model.","type":"string"},"maxIterations":{"description":"The maximum number of iterations in training. Used only for iterative training algorithms.","format":"int64","type":"string"},"maxParallelTrials":{"description":"Maximum number of trials to run in parallel.","format":"int64","type":"string"},"maxReplicaCount":{"description":"The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count.","format":"int64","type":"string"},"maxTimeSeriesLength":{"description":"The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.","format":"int64","type":"string"},"maxTreeDepth":{"description":"Maximum depth of a tree for boosted tree models.","format":"int64","type":"string"},"minAprioriSupport":{"description":"The apriori support minimum. Applies to contribution analysis models.","format":"double","type":"number"},"minRelativeProgress":{"description":"When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.","format":"double","type":"number"},"minReplicaCount":{"description":"The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1.","format":"int64","type":"string"},"minSplitLoss":{"description":"Minimum split loss for boosted tree models.","format":"double","type":"number"},"minTimeSeriesLength":{"description":"The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points.","format":"int64","type":"string"},"minTreeChildWeight":{"description":"Minimum sum of instance weight needed in a child for boosted tree models.","format":"int64","type":"string"},"modelGardenModelName":{"description":"The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`.","type":"string"},"modelRegistry":{"description":"The model registry.","enum":["MODEL_REGISTRY_UNSPECIFIED","VERTEX_AI"],"type":"string"},"modelUri":{"description":"Google Cloud Storage URI from which the model was imported. Only applicable for imported models.","type":"string"},"nonSeasonalOrder":{"$ref":"#/components/schemas/bigquery_v2_ArimaOrder"},"numClusters":{"description":"Number of clusters for clustering models.","format":"int64","type":"string"},"numFactors":{"description":"Num factors specified for matrix factorization models.","format":"int64","type":"string"},"numParallelTree":{"description":"Number of parallel trees constructed during each iteration for boosted tree models.","format":"int64","type":"string"},"numPrincipalComponents":{"description":"Number of principal components to keep in the PCA model. Must be <= the number of features.","format":"int64","type":"string"},"numTrials":{"description":"Number of trials to run this hyperparameter tuning job.","format":"int64","type":"string"},"optimizationStrategy":{"description":"Optimization strategy for training linear regression models.","enum":["OPTIMIZATION_STRATEGY_UNSPECIFIED","BATCH_GRADIENT_DESCENT","NORMAL_EQUATION"],"type":"string"},"optimizer":{"description":"Optimizer used for training the neural nets.","type":"string"},"pcaExplainedVarianceRatio":{"description":"The minimum ratio of cumulative explained variance that needs to be given by the PCA model.","format":"double","type":"number"},"pcaSolver":{"description":"The solver for PCA.","enum":["UNSPECIFIED","FULL","RANDOMIZED","AUTO"],"type":"string"},"reservationAffinityKey":{"description":"Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.","type":"string"},"reservationAffinityType":{"description":"Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`.","enum":["RESERVATION_AFFINITY_TYPE_UNSPECIFIED","NO_RESERVATION","ANY_RESERVATION","SPECIFIC_RESERVATION"],"type":"string"},"reservationAffinityValues":{"description":"Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block.","type":"array","items":{"type":"string"}},"sampledShapleyNumPaths":{"description":"Number of paths for the sampled Shapley explain method.","format":"int64","type":"string"},"scaleFeatures":{"description":"If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA.","type":"boolean"},"standardizeFeatures":{"description":"Whether to standardize numerical features. Default to true.","type":"boolean"},"subsample":{"description":"Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.","format":"double","type":"number"},"tfVersion":{"description":"Based on the selected TF version, the corresponding docker image is used to train external models.","type":"string"},"timeSeriesDataColumn":{"description":"Column to be designated as time series data for ARIMA model.","type":"string"},"timeSeriesIdColumn":{"description":"The time series id column that was used during ARIMA model training.","type":"string"},"timeSeriesIdColumns":{"description":"The time series id columns that were used during ARIMA model training.","type":"array","items":{"type":"string"}},"timeSeriesLengthFraction":{"description":"The fraction of the interpolated length of the time series that's used to model the time series trend component. All of the time points of the time series are used to model the non-trend component. This training option accelerates modeling training without sacrificing much forecasting accuracy. You can use this option with `minTimeSeriesLength` but not with `maxTimeSeriesLength`.","format":"double","type":"number"},"timeSeriesTimestampColumn":{"description":"Column to be designated as time series timestamp for ARIMA model.","type":"string"},"treeMethod":{"description":"Tree construction algorithm for boosted tree models.","enum":["TREE_METHOD_UNSPECIFIED","AUTO","EXACT","APPROX","HIST"],"type":"string"},"trendSmoothingWindowSize":{"description":"Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied.","format":"int64","type":"string"},"userColumn":{"description":"User column specified for matrix factorization models.","type":"string"},"vertexAiModelVersionAliases":{"description":"The version aliases to apply in Vertex AI model registry. Always overwrite if the version aliases exists in a existing model.","type":"array","items":{"type":"string"}},"walsAlpha":{"description":"Hyperparameter for matrix factoration when implicit feedback type is specified.","format":"double","type":"number"},"warmStart":{"description":"Whether to train a model from the last checkpoint.","type":"boolean"},"xgboostVersion":{"description":"User-selected XGBoost versions for training of XGBoost models.","type":"string"}}},"bigquery_v2_TrainingRun":{"description":"Information about a single training query run for the model.","type":"object","properties":{"classLevelGlobalExplanations":{"description":"Output only. Global explanation contains the explanation of top features on the class level. Applies to classification models only.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_GlobalExplanation"}},"dataSplitResult":{"$ref":"#/components/schemas/bigquery_v2_DataSplitResult"},"evaluationMetrics":{"$ref":"#/components/schemas/bigquery_v2_EvaluationMetrics"},"modelLevelGlobalExplanation":{"$ref":"#/components/schemas/bigquery_v2_GlobalExplanation"},"results":{"description":"Output only. Output of each iteration run, results.size() <= max_iterations.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IterationResult"}},"startTime":{"description":"Output only. The start time of this training run.","format":"google-datetime","readOnly":true,"type":"string"},"trainingOptions":{"$ref":"#/components/schemas/bigquery_v2_TrainingOptions"},"trainingStartTime":{"description":"Output only. The start time of this training run, in milliseconds since epoch.","format":"int64","readOnly":true,"type":"string"},"vertexAiModelId":{"description":"The model id in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-registry/introduction) for this training run.","type":"string"},"vertexAiModelVersion":{"description":"Output only. The model version in the [Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-registry/introduction) for this training run.","readOnly":true,"type":"string"}}},"bigquery_v2_TransactionInfo":{"description":"[Alpha] Information of a multi-statement transaction.","type":"object","properties":{"transactionId":{"description":"Output only. [Alpha] Id of the transaction.","readOnly":true,"type":"string"}}},"bigquery_v2_TransformColumn":{"description":"Information about a single transform column.","type":"object","properties":{"name":{"description":"Output only. Name of the column.","readOnly":true,"type":"string"},"transformSql":{"description":"Output only. The SQL expression used in the column transform.","readOnly":true,"type":"string"},"type":{"$ref":"#/components/schemas/bigquery_v2_StandardSqlDataType"}}},"bigquery_v2_UndeleteDatasetRequest":{"description":"Request format for undeleting a dataset.","type":"object","properties":{"deletionTime":{"description":"Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. Undeleting a dataset using deletion time is not supported.","format":"google-datetime","type":"string"}}},"bigquery_v2_UserDefinedFunctionResource":{"description":" This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions","type":"object","properties":{"inlineCode":{"description":"[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.","type":"string"},"resourceUri":{"description":"[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).","type":"string"}}},"bigquery_v2_VectorSearchStatistics":{"description":"Statistics for a vector search query. Populated as part of JobStatistics2.","type":"object","properties":{"indexUnusedReasons":{"description":"When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_IndexUnusedReason"}},"indexUsageMode":{"description":"Specifies the index usage mode for the query.","enum":["INDEX_USAGE_MODE_UNSPECIFIED","UNUSED","PARTIALLY_USED","FULLY_USED"],"type":"string"},"storedColumnsUsages":{"description":"Specifies the usage of stored columns in the query when stored columns are used in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_StoredColumnsUsage"}}}},"bigquery_v2_ViewDefinition":{"description":"Describes the definition of a logical view.","type":"object","properties":{"foreignDefinitions":{"description":"Optional. Foreign view representations.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_ForeignViewDefinition"}},"privacyPolicy":{"$ref":"#/components/schemas/bigquery_v2_PrivacyPolicy"},"query":{"description":"Required. A query that BigQuery executes when the view is referenced.","type":"string"},"useExplicitColumnNames":{"description":"True if the column names are explicitly specified. For example by using the 'CREATE VIEW v(c1, c2) AS ...' syntax. Can only be set for GoogleSQL views.","type":"boolean"},"useLegacySql":{"description":"Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). Queries and views that reference this view must use the same flag value. A wrapper is used here because the default value is True.","type":"boolean"},"userDefinedFunctionResources":{"description":"Describes user-defined function resources used in the query.","type":"array","items":{"$ref":"#/components/schemas/bigquery_v2_UserDefinedFunctionResource"}}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/bigquery":"View and manage your data in Google BigQuery and see the email address for your Google Account"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/bigquery"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/bigquery/v2/rest","service":"bigquery","version":"v2"}]}} \ No newline at end of file diff --git a/public/specs/google/google-calendar.json b/public/specs/google/google-calendar.json index 48e52ea7..781b4b43 100644 --- a/public/specs/google/google-calendar.json +++ b/public/specs/google/google-calendar.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Calendar API","version":"v3","description":"Manipulates events and other calendar data."},"servers":[{"url":"https://www.googleapis.com/calendar/v3/"}],"paths":{"/calendars":{"post":{"operationId":"calendar.calendars.insert","x-executor-toolPath":"calendar.calendars.insert","tags":["Calendar API"],"description":"Creates a secondary calendar.\nThe authenticated user for the request is made the data owner of the new calendar.\n\nNote: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior. For example, if a service account is the data owner, data ownership cannot be transferred.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}":{"get":{"operationId":"calendar.calendars.get","x-executor-toolPath":"calendar.calendars.get","tags":["Calendar API"],"description":"Returns metadata for a calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.calendars.update","x-executor-toolPath":"calendar.calendars.update","tags":["Calendar API"],"description":"Updates metadata for a calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.calendars.delete","x-executor-toolPath":"calendar.calendars.delete","tags":["Calendar API"],"description":"Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.calendars.patch","x-executor-toolPath":"calendar.calendars.patch","tags":["Calendar API"],"description":"Updates metadata for a calendar. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/acl":{"get":{"operationId":"calendar.acl.list","x-executor-toolPath":"calendar.acl.list","tags":["Calendar API"],"description":"Returns the rules in the access control list for the calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","schema":{"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Acl"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"post":{"operationId":"calendar.acl.insert","x-executor-toolPath":"calendar.acl.insert","tags":["Calendar API"],"description":"Creates an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Whether to send notifications about the calendar sharing change. Optional. The default is True.","schema":{"description":"Whether to send notifications about the calendar sharing change. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/acl/watch":{"post":{"operationId":"calendar.acl.watch","x-executor-toolPath":"calendar.acl.watch","tags":["Calendar API"],"description":"Watch for changes to ACL resources.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","schema":{"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/acl/{ruleId}":{"get":{"operationId":"calendar.acl.get","x-executor-toolPath":"calendar.acl.get","tags":["Calendar API"],"description":"Returns an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.acl.update","x-executor-toolPath":"calendar.acl.update","tags":["Calendar API"],"description":"Updates an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","schema":{"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.acl.delete","x-executor-toolPath":"calendar.acl.delete","tags":["Calendar API"],"description":"Deletes an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.acl.patch","x-executor-toolPath":"calendar.acl.patch","tags":["Calendar API"],"description":"Updates an access control rule. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","schema":{"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/clear":{"post":{"operationId":"calendar.calendars.clear","x-executor-toolPath":"calendar.calendars.clear","tags":["Calendar API"],"description":"Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events":{"get":{"operationId":"calendar.events.list","x-executor-toolPath":"calendar.events.list","tags":["Calendar API"],"description":"Returns events on the specified calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored.","schema":{"description":"Deprecated and ignored.","type":"boolean"},"style":"form","explode":false},{"name":"eventTypes","in":"query","required":false,"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","schema":{"type":"array","items":{"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","enum":["birthday","default","focusTime","fromGmail","outOfOffice","workingLocation"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"iCalUID","in":"query","required":false,"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","schema":{"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","schema":{"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","format":"int32","default":250,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","schema":{"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","enum":["startTime","updated"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"privateExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"q","in":"query","required":false,"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","schema":{"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sharedExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","schema":{"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHiddenInvitations","in":"query","required":false,"description":"Whether to include hidden invitations in the result. Optional. The default is False.","schema":{"description":"Whether to include hidden invitations in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"singleEvents","in":"query","required":false,"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","schema":{"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"timeMax","in":"query","required":false,"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","schema":{"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeMin","in":"query","required":false,"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","schema":{"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"updatedMin","in":"query","required":false,"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","schema":{"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Events"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"post":{"operationId":"calendar.events.insert","x-executor-toolPath":"calendar.events.insert","tags":["Calendar API"],"description":"Creates an event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.","schema":{"description":"Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/import":{"post":{"operationId":"calendar.events.import","x-executor-toolPath":"calendar.events.import","tags":["Calendar API"],"description":"Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported.\nDeprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/quickAdd":{"post":{"operationId":"calendar.events.quickAdd","x-executor-toolPath":"calendar.events.quickAdd","tags":["Calendar API"],"description":"Creates an event based on a simple text string.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the creation of the new event.","schema":{"description":"Guests who should receive notifications about the creation of the new event.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"text","in":"query","required":true,"description":"The text describing the event to be created.","schema":{"description":"The text describing the event to be created.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/watch":{"post":{"operationId":"calendar.events.watch","x-executor-toolPath":"calendar.events.watch","tags":["Calendar API"],"description":"Watch for changes to Events resources.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored.","schema":{"description":"Deprecated and ignored.","type":"boolean"},"style":"form","explode":false},{"name":"eventTypes","in":"query","required":false,"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","schema":{"type":"array","items":{"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","enum":["birthday","default","focusTime","fromGmail","outOfOffice","workingLocation"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"iCalUID","in":"query","required":false,"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","schema":{"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","schema":{"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","format":"int32","default":250,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","schema":{"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","enum":["startTime","updated"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"privateExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"q","in":"query","required":false,"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","schema":{"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sharedExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","schema":{"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHiddenInvitations","in":"query","required":false,"description":"Whether to include hidden invitations in the result. Optional. The default is False.","schema":{"description":"Whether to include hidden invitations in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"singleEvents","in":"query","required":false,"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","schema":{"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"timeMax","in":"query","required":false,"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","schema":{"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeMin","in":"query","required":false,"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","schema":{"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"updatedMin","in":"query","required":false,"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","schema":{"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/{eventId}":{"get":{"operationId":"calendar.events.get","x-executor-toolPath":"calendar.events.get","tags":["Calendar API"],"description":"Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.events.update","x-executor-toolPath":"calendar.events.update","tags":["Calendar API"],"description":"Updates an event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","schema":{"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.events.delete","x-executor-toolPath":"calendar.events.delete","tags":["Calendar API"],"description":"Deletes an event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the deletion of the event.","schema":{"description":"Guests who should receive notifications about the deletion of the event.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.events.patch","x-executor-toolPath":"calendar.events.patch","tags":["Calendar API"],"description":"Updates an event. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","schema":{"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/{eventId}/instances":{"get":{"operationId":"calendar.events.instances","x-executor-toolPath":"calendar.events.instances","tags":["Calendar API"],"description":"Returns instances of the specified recurring event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Recurring event identifier.","schema":{"description":"Recurring event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","schema":{"description":"Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"originalStart","in":"query","required":false,"description":"The original start time of the instance in the result. Optional.","schema":{"description":"The original start time of the instance in the result. Optional.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.","schema":{"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"timeMax","in":"query","required":false,"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.","schema":{"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeMin","in":"query","required":false,"description":"Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.","schema":{"description":"Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Events"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/{eventId}/move":{"post":{"operationId":"calendar.events.move","x-executor-toolPath":"calendar.events.move","tags":["Calendar API"],"description":"Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier of the source calendar where the event currently is on.","schema":{"description":"Calendar identifier of the source calendar where the event currently is on.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"destination","in":"query","required":true,"description":"Calendar identifier of the target calendar where the event is to be moved to.","schema":{"description":"Calendar identifier of the target calendar where the event is to be moved to.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the change of the event's organizer.","schema":{"description":"Guests who should receive notifications about the change of the event's organizer.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/channels/stop":{"post":{"operationId":"calendar.channels.stop","x-executor-toolPath":"calendar.channels.stop","tags":["Calendar API"],"description":"Stop watching resources through this channel","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/colors":{"get":{"operationId":"calendar.colors.get","x-executor-toolPath":"calendar.colors.get","tags":["Calendar API"],"description":"Returns the color definitions for calendars and events.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Colors"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/freeBusy":{"post":{"operationId":"calendar.freebusy.query","x-executor-toolPath":"calendar.freebusy.query","tags":["Calendar API"],"description":"Returns free/busy information for a set of calendars.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_FreeBusyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_FreeBusyResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/users/me/calendarList":{"get":{"operationId":"calendar.calendarList.list","x-executor-toolPath":"calendar.calendarList.list","tags":["Calendar API"],"description":"Returns the calendars on the user's calendar list.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"minAccessRole","in":"query","required":false,"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","schema":{"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","enum":["freeBusyReader","owner","reader","writer","writerWithoutPrivateAccess"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","schema":{"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHidden","in":"query","required":false,"description":"Whether to show hidden entries. Optional. The default is False.","schema":{"description":"Whether to show hidden entries. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showOwnOrganizationOnly","in":"query","required":false,"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","schema":{"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"post":{"operationId":"calendar.calendarList.insert","x-executor-toolPath":"calendar.calendarList.insert","tags":["Calendar API"],"description":"Inserts an existing calendar into the user's calendar list.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"colorRgbFormat","in":"query","required":false,"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","schema":{"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/users/me/calendarList/watch":{"post":{"operationId":"calendar.calendarList.watch","x-executor-toolPath":"calendar.calendarList.watch","tags":["Calendar API"],"description":"Watch for changes to CalendarList resources.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"minAccessRole","in":"query","required":false,"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","schema":{"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","enum":["freeBusyReader","owner","reader","writer","writerWithoutPrivateAccess"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","schema":{"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHidden","in":"query","required":false,"description":"Whether to show hidden entries. Optional. The default is False.","schema":{"description":"Whether to show hidden entries. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showOwnOrganizationOnly","in":"query","required":false,"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","schema":{"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/users/me/calendarList/{calendarId}":{"get":{"operationId":"calendar.calendarList.get","x-executor-toolPath":"calendar.calendarList.get","tags":["Calendar API"],"description":"Returns a calendar from the user's calendar list.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.calendarList.update","x-executor-toolPath":"calendar.calendarList.update","tags":["Calendar API"],"description":"Updates an existing calendar on the user's calendar list.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"colorRgbFormat","in":"query","required":false,"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","schema":{"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.calendarList.delete","x-executor-toolPath":"calendar.calendarList.delete","tags":["Calendar API"],"description":"Removes a calendar from the user's calendar list.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.calendarList.patch","x-executor-toolPath":"calendar.calendarList.patch","tags":["Calendar API"],"description":"Updates an existing calendar on the user's calendar list. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"colorRgbFormat","in":"query","required":false,"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","schema":{"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/users/me/settings":{"get":{"operationId":"calendar.settings.list","x-executor-toolPath":"calendar.settings.list","tags":["Calendar API"],"description":"Returns all user settings for the authenticated user.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Settings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/users/me/settings/watch":{"post":{"operationId":"calendar.settings.watch","x-executor-toolPath":"calendar.settings.watch","tags":["Calendar API"],"description":"Watch for changes to Settings resources.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}},"/users/me/settings/{setting}":{"get":{"operationId":"calendar.settings.get","x-executor-toolPath":"calendar.settings.get","tags":["Calendar API"],"description":"Returns a single user setting.","parameters":[{"name":"setting","in":"path","required":true,"description":"The id of the user setting.","schema":{"description":"The id of the user setting.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Setting"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar"]}}},"components":{"schemas":{"calendar_v3_Acl":{"type":"object","properties":{"etag":{"description":"ETag of the collection.","type":"string"},"items":{"description":"List of rules on the access control list.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_AclRule"}},"kind":{"description":"Type of the collection (\"calendar#acl\").","default":"calendar#acl","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"}}},"calendar_v3_AclRule":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"Identifier of the Access Control List (ACL) rule. See Sharing calendars.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#aclRule\").","default":"calendar#aclRule","type":"string"},"role":{"description":"The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.","type":"string"},"scope":{"description":"The extent to which calendar access is granted by this ACL rule.","type":"object","properties":{"type":{"description":"The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.","type":"string"},"value":{"description":"The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\".","type":"string"}}}}},"calendar_v3_Calendar":{"type":"object","properties":{"autoAcceptInvitations":{"description":"Whether this calendar automatically accepts invitations. Only valid for resource calendars.","type":"boolean"},"conferenceProperties":{"$ref":"#/components/schemas/calendar_v3_ConferenceProperties"},"dataOwner":{"description":"The email of the owner of the calendar. Set only for secondary calendars. Read-only.","type":"string"},"description":{"description":"Description of the calendar. Optional.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"Identifier of the calendar. To retrieve IDs call the calendarList.list() method.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#calendar\").","default":"calendar#calendar","type":"string"},"labelProperties":{"$ref":"#/components/schemas/calendar_v3_LabelProperties"},"location":{"description":"Geographic location of the calendar as free-form text. Optional.","type":"string"},"summary":{"description":"Title of the calendar.","type":"string"},"timeZone":{"description":"The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.","type":"string"}}},"calendar_v3_CalendarList":{"type":"object","properties":{"etag":{"description":"ETag of the collection.","type":"string"},"items":{"description":"Calendars that are present on the user's calendar list.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}},"kind":{"description":"Type of the collection (\"calendar#calendarList\").","default":"calendar#calendarList","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"}}},"calendar_v3_CalendarListEntry":{"type":"object","properties":{"accessRole":{"description":"The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.","type":"string"},"autoAcceptInvitations":{"description":"Whether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only.","type":"boolean"},"backgroundColor":{"description":"The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.","type":"string"},"colorId":{"description":"The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.","type":"string"},"conferenceProperties":{"$ref":"#/components/schemas/calendar_v3_ConferenceProperties"},"dataOwner":{"description":"The email of the owner of the calendar. Set only for secondary calendars. Read-only.","type":"string"},"defaultReminders":{"description":"The default reminders that the authenticated user has for this calendar.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventReminder"}},"deleted":{"description":"Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.","default":false,"type":"boolean"},"description":{"description":"Description of the calendar. Optional. Read-only.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"foregroundColor":{"description":"The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.","type":"string"},"hidden":{"description":"Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.","default":false,"type":"boolean"},"id":{"description":"Identifier of the calendar.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#calendarListEntry\").","default":"calendar#calendarListEntry","type":"string"},"location":{"description":"Geographic location of the calendar as free-form text. Optional. Read-only.","type":"string"},"notificationSettings":{"description":"The notifications that the authenticated user is receiving for this calendar.","type":"object","properties":{"notifications":{"description":"The list of notifications set for this calendar.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_CalendarNotification"}}}},"primary":{"description":"Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.","default":false,"type":"boolean"},"selected":{"description":"Whether the calendar content shows up in the calendar UI. Optional. The default is False.","default":false,"type":"boolean"},"summary":{"description":"Title of the calendar. Read-only.","type":"string"},"summaryOverride":{"description":"The summary that the authenticated user has set for this calendar. Optional.","type":"string"},"timeZone":{"description":"The time zone of the calendar. Optional. Read-only.","type":"string"}}},"calendar_v3_CalendarNotification":{"type":"object","properties":{"method":{"description":"The method used to deliver the notification. The possible value is: \n- \"email\" - Notifications are sent via email. \nRequired when adding a notification.","type":"string"},"type":{"description":"The type of notification. Possible values are: \n- \"eventCreation\" - Notification sent when a new event is put on the calendar. \n- \"eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\" - Notification sent when an event is cancelled. \n- \"eventResponse\" - Notification sent when an attendee responds to the event invitation. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning). \nRequired when adding a notification.","type":"string"}}},"calendar_v3_Channel":{"type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional.","type":"object","additionalProperties":{"description":"Declares a new parameter by name.","type":"string"}},"payload":{"description":"A Boolean value to indicate whether payload is wanted. Optional.","type":"boolean"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.","type":"string"}}},"calendar_v3_ColorDefinition":{"type":"object","properties":{"background":{"description":"The background color associated with this color definition.","type":"string"},"foreground":{"description":"The foreground color that can be used to write on top of a background with 'background' color.","type":"string"}}},"calendar_v3_Colors":{"type":"object","properties":{"calendar":{"description":"A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_ColorDefinition"}},"event":{"description":"A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_ColorDefinition"}},"kind":{"description":"Type of the resource (\"calendar#colors\").","default":"calendar#colors","type":"string"},"updated":{"description":"Last modification time of the color palette (as a RFC3339 timestamp). Read-only.","format":"date-time","type":"string"}}},"calendar_v3_ConferenceData":{"type":"object","properties":{"conferenceId":{"description":"The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nThe ID value is formed differently for each conference solution type: \n- eventHangout: ID is not set. (This conference type is deprecated.)\n- eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)\n- hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.\n- addOn: ID is defined by the third-party provider. Optional.","type":"string"},"conferenceSolution":{"$ref":"#/components/schemas/calendar_v3_ConferenceSolution"},"createRequest":{"$ref":"#/components/schemas/calendar_v3_CreateConferenceRequest"},"entryPoints":{"description":"Information about individual conference entry points, such as URLs or phone numbers.\nAll of them must belong to the same conference.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EntryPoint"}},"notes":{"description":"Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.","type":"string"},"parameters":{"$ref":"#/components/schemas/calendar_v3_ConferenceParameters"},"signature":{"description":"The signature of the conference data.\nGenerated on server side.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request.","type":"string"}}},"calendar_v3_ConferenceParameters":{"type":"object","properties":{"addOnParameters":{"$ref":"#/components/schemas/calendar_v3_ConferenceParametersAddOnParameters"}}},"calendar_v3_ConferenceParametersAddOnParameters":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"calendar_v3_ConferenceProperties":{"type":"object","properties":{"allowedConferenceSolutionTypes":{"description":"The types of conference solutions that are supported for this calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\" \n- \"hangoutsMeet\" Optional.","type":"array","items":{"type":"string"}}}},"calendar_v3_ConferenceRequestStatus":{"type":"object","properties":{"statusCode":{"description":"The current status of the conference create request. Read-only.\nThe possible values are: \n- \"pending\": the conference create request is still being processed.\n- \"success\": the conference create request succeeded, the entry points are populated.\n- \"failure\": the conference create request failed, there are no entry points.","type":"string"}}},"calendar_v3_ConferenceSolution":{"type":"object","properties":{"iconUri":{"description":"The user-visible icon for this solution.","type":"string"},"key":{"$ref":"#/components/schemas/calendar_v3_ConferenceSolutionKey"},"name":{"description":"The user-visible name of this solution. Not localized.","type":"string"}}},"calendar_v3_ConferenceSolutionKey":{"type":"object","properties":{"type":{"description":"The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"eventNamedHangout\" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers","type":"string"}}},"calendar_v3_CreateConferenceRequest":{"type":"object","properties":{"conferenceSolutionKey":{"$ref":"#/components/schemas/calendar_v3_ConferenceSolutionKey"},"requestId":{"description":"The client-generated unique ID for this request.\nClients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.","type":"string"},"status":{"$ref":"#/components/schemas/calendar_v3_ConferenceRequestStatus"}}},"calendar_v3_EntryPoint":{"type":"object","properties":{"accessCode":{"description":"The access code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"entryPointFeatures":{"description":"Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.","type":"array","items":{"type":"string"}},"entryPointType":{"description":"The type of the conference entry point.\nPossible values are: \n- \"video\" - joining a conference over HTTP. A conference can have zero or one video entry point.\n- \"phone\" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.\n- \"sip\" - joining a conference over SIP. A conference can have zero or one sip entry point.\n- \"more\" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.","type":"string"},"label":{"description":"The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n- for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for more: should not be filled \nOptional.","type":"string"},"meetingCode":{"description":"The meeting code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"passcode":{"description":"The passcode to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.","type":"string"},"password":{"description":"The password to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"pin":{"description":"The PIN to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"regionCode":{"description":"The CLDR/ISO 3166 region code for the country associated with this phone access. Example: \"SE\" for Sweden.\nCalendar backend will populate this field only for EntryPointType.PHONE.","type":"string"},"uri":{"description":"The URI of the entry point. The maximum length is 1300 characters.\nFormat: \n- for video, http: or https: schema is required.\n- for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.\n- for more, http: or https: schema is required.","type":"string"}}},"calendar_v3_Error":{"type":"object","properties":{"domain":{"description":"Domain, or broad category, of the error.","type":"string"},"reason":{"description":"Specific reason for the error. Some of the possible values are: \n- \"groupTooBig\" - The group of users requested is too large for a single query. \n- \"tooManyCalendarsRequested\" - The number of calendars requested is too large for a single query. \n- \"notFound\" - The requested resource was not found. \n- \"internalError\" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.","type":"string"}}},"calendar_v3_Event":{"type":"object","properties":{"anyoneCanAddSelf":{"description":"Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.","default":false,"type":"boolean"},"attachments":{"description":"File attachments for the event.\nIn order to modify attachments the supportsAttachments request parameter should be set to true.\nThere can be at most 25 attachments per event,","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventAttachment"}},"attendees":{"description":"The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventAttendee"}},"attendeesOmitted":{"description":"Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.","default":false,"type":"boolean"},"birthdayProperties":{"$ref":"#/components/schemas/calendar_v3_EventBirthdayProperties"},"colorId":{"description":"The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.","type":"string"},"conferenceData":{"$ref":"#/components/schemas/calendar_v3_ConferenceData"},"created":{"description":"Creation time of the event (as a RFC3339 timestamp). Read-only.","format":"date-time","type":"string"},"creator":{"description":"The creator of the event. Read-only.","type":"object","properties":{"displayName":{"description":"The creator's name, if available.","type":"string"},"email":{"description":"The creator's email address, if available.","type":"string"},"id":{"description":"The creator's Profile ID, if available.","type":"string"},"self":{"description":"Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.","default":false,"type":"boolean"}}},"description":{"description":"Description of the event. Can contain HTML. Optional.","type":"string"},"end":{"$ref":"#/components/schemas/calendar_v3_EventDateTime"},"endTimeUnspecified":{"description":"Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.","default":false,"type":"boolean"},"etag":{"description":"ETag of the resource.","type":"string"},"eventLabelId":{"description":"The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.)\nThis property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods.\nSetting an empty string, or not setting this field at all, will remove the existing label from the event.","type":"string"},"eventType":{"description":"Specific type of the event. This cannot be modified after the event is created. Possible values are: \n- \"birthday\" - A special all-day event with an annual recurrence. \n- \"default\" - A regular event or not further specified. \n- \"focusTime\" - A focus-time event. \n- \"fromGmail\" - An event from Gmail. This type of event cannot be created. \n- \"outOfOffice\" - An out-of-office event. \n- \"workingLocation\" - A working location event.","default":"default","type":"string"},"extendedProperties":{"description":"Extended properties of the event.","type":"object","properties":{"private":{"description":"Properties that are private to the copy of the event that appears on this calendar.","type":"object","additionalProperties":{"description":"The name of the private property and the corresponding value.","type":"string"}},"shared":{"description":"Properties that are shared between copies of the event on other attendees' calendars.","type":"object","additionalProperties":{"description":"The name of the shared property and the corresponding value.","type":"string"}}}},"focusTimeProperties":{"$ref":"#/components/schemas/calendar_v3_EventFocusTimeProperties"},"gadget":{"description":"A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.","type":"object","properties":{"display":{"description":"The gadget's display mode. Deprecated. Possible values are: \n- \"icon\" - The gadget displays next to the event's title in the calendar view. \n- \"chip\" - The gadget displays when the event is clicked.","type":"string"},"height":{"description":"The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.","format":"int32","type":"integer"},"iconLink":{"description":"The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.","type":"string"},"link":{"description":"The gadget's URL. The URL scheme must be HTTPS. Deprecated.","type":"string"},"preferences":{"description":"Preferences.","type":"object","additionalProperties":{"description":"The preference name and corresponding value.","type":"string"}},"title":{"description":"The gadget's title. Deprecated.","type":"string"},"type":{"description":"The gadget's type. Deprecated.","type":"string"},"width":{"description":"The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.","format":"int32","type":"integer"}}},"guestsCanInviteOthers":{"description":"Whether attendees other than the organizer can invite others to the event. Optional. The default is True.","default":true,"type":"boolean"},"guestsCanModify":{"description":"Whether attendees other than the organizer can modify the event. Optional. The default is False.","default":false,"type":"boolean"},"guestsCanSeeOtherGuests":{"description":"Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.","default":true,"type":"boolean"},"hangoutLink":{"description":"An absolute link to the Google Hangout associated with this event. Read-only.","type":"string"},"htmlLink":{"description":"An absolute link to this event in the Google Calendar Web UI. Read-only.","type":"string"},"iCalUID":{"description":"Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.\nNote that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.","type":"string"},"id":{"description":"Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: \n- characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 \n- the length of the ID must be between 5 and 1024 characters \n- the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.\nIf you do not specify an ID, it will be automatically generated by the server.\nNote that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#event\").","default":"calendar#event","type":"string"},"location":{"description":"Geographic location of the event as free-form text. Optional.","type":"string"},"locked":{"description":"Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only.","default":false,"type":"boolean"},"organizer":{"description":"The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.","type":"object","properties":{"displayName":{"description":"The organizer's name, if available.","type":"string"},"email":{"description":"The organizer's email address, if available. It must be a valid email address as per RFC5322.","type":"string"},"id":{"description":"The organizer's Profile ID, if available.","type":"string"},"self":{"description":"Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.","default":false,"type":"boolean"}}},"originalStartTime":{"$ref":"#/components/schemas/calendar_v3_EventDateTime"},"outOfOfficeProperties":{"$ref":"#/components/schemas/calendar_v3_EventOutOfOfficeProperties"},"privateCopy":{"description":"If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.","default":false,"type":"boolean"},"recurrence":{"description":"List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.","type":"array","items":{"type":"string"}},"recurringEventId":{"description":"For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.","type":"string"},"reminders":{"description":"Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.","type":"object","properties":{"overrides":{"description":"If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventReminder"}},"useDefault":{"description":"Whether the default reminders of the calendar apply to the event.","type":"boolean"}}},"sequence":{"description":"Sequence number as per iCalendar.","format":"int32","type":"integer"},"source":{"description":"Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.","type":"object","properties":{"title":{"description":"Title of the source; for example a title of a web page or an email subject.","type":"string"},"url":{"description":"URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.","type":"string"}}},"start":{"$ref":"#/components/schemas/calendar_v3_EventDateTime"},"status":{"description":"Status of the event. Optional. Possible values are: \n- \"confirmed\" - The event is confirmed. This is the default status. \n- \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.\nA cancelled status represents two different states depending on the event type: \n- Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.\nCancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. \n- All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.\nDeleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.\nIf an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.","type":"string"},"summary":{"description":"Title of the event.","type":"string"},"transparency":{"description":"Whether the event blocks time on the calendar. Optional. Possible values are: \n- \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. \n- \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.","default":"opaque","type":"string"},"updated":{"description":"Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.","format":"date-time","type":"string"},"visibility":{"description":"Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons. \nNote on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event.","default":"default","type":"string"},"workingLocationProperties":{"$ref":"#/components/schemas/calendar_v3_EventWorkingLocationProperties"}}},"calendar_v3_EventAttachment":{"type":"object","properties":{"fileId":{"description":"ID of the attached file. Read-only.\nFor Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.","type":"string"},"fileUrl":{"description":"URL link to the attachment.\nFor adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.\nRequired when adding an attachment.","type":"string"},"iconLink":{"description":"URL link to the attachment's icon. This field can only be modified for custom third-party attachments.","type":"string"},"mimeType":{"description":"Internet media type (MIME type) of the attachment.","type":"string"},"title":{"description":"Attachment title.","type":"string"}}},"calendar_v3_EventAttendee":{"type":"object","properties":{"additionalGuests":{"description":"Number of additional guests. Optional. The default is 0.","format":"int32","default":0,"type":"integer"},"asyncOperation":{"description":"If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present.\nPossible values are: \n- \"inProgress\" - The asynchronous operation is in progress. \n- (not present) - Otherwise.","default":"","type":"string"},"comment":{"description":"The attendee's response comment. Optional.","type":"string"},"displayName":{"description":"The attendee's name, if available. Optional.","type":"string"},"email":{"description":"The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.\nRequired when adding an attendee.","type":"string"},"id":{"description":"The attendee's Profile ID, if available.","type":"string"},"optional":{"description":"Whether this is an optional attendee. Optional. The default is False.","default":false,"type":"boolean"},"organizer":{"description":"Whether the attendee is the organizer of the event. Read-only. The default is False.","type":"boolean"},"resource":{"description":"Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.","default":false,"type":"boolean"},"responseStatus":{"description":"The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation (recommended for new events). \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the \"Add invitations to my calendar\" setting set to \"When I respond to invitation in email\" or \"Only if the sender is known\" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests.","type":"string"},"self":{"description":"Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.","default":false,"type":"boolean"}}},"calendar_v3_EventBirthdayProperties":{"type":"object","properties":{"contact":{"description":"Resource name of the contact this birthday event is linked to. This can be used to fetch contact details from People API. Format: \"people/c12345\". Read-only.","type":"string"},"customTypeName":{"description":"Custom type label specified for this event. This is populated if birthdayProperties.type is set to \"custom\". Read-only.","type":"string"},"type":{"description":"Type of birthday or special event. Possible values are: \n- \"anniversary\" - An anniversary other than birthday. Always has a contact. \n- \"birthday\" - A birthday event. This is the default value. \n- \"custom\" - A special date whose label is further specified in the customTypeName field. Always has a contact. \n- \"other\" - A special date which does not fall into the other categories, and does not have a custom label. Always has a contact. \n- \"self\" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type \"birthday\". The type cannot be changed after the event is created.","default":"birthday","type":"string"}}},"calendar_v3_EventDateTime":{"type":"object","properties":{"date":{"description":"The date, in the format \"yyyy-mm-dd\", if this is an all-day event.","format":"date","type":"string"},"dateTime":{"description":"The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.","format":"date-time","type":"string"},"timeZone":{"description":"The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.","type":"string"}}},"calendar_v3_EventFocusTimeProperties":{"type":"object","properties":{"autoDeclineMode":{"description":"Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined.","type":"string"},"chatStatus":{"description":"The status to mark the user in Chat and related products. This can be available or doNotDisturb.","type":"string"},"declineMessage":{"description":"Response message to set if an existing event or new invitation is automatically declined by Calendar.","type":"string"}}},"calendar_v3_EventLabel":{"type":"object","properties":{"backgroundColor":{"description":"Background color of the label in hexadecimal format, such as \"#039be5\". Events with this label are displayed in this color. Required.","type":"string"},"id":{"description":"The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label.\nIf provided, the ID must be unique within the calendar and follow UUID format.","type":"string"},"name":{"description":"Name of the label. Optional.\nIf provided this must have at most 50 characters.","type":"string"}}},"calendar_v3_EventOutOfOfficeProperties":{"type":"object","properties":{"autoDeclineMode":{"description":"Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined.","type":"string"},"declineMessage":{"description":"Response message to set if an existing event or new invitation is automatically declined by Calendar.","type":"string"}}},"calendar_v3_EventReminder":{"type":"object","properties":{"method":{"description":"The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"popup\" - Reminders are sent via a UI popup. \nRequired when adding a reminder.","type":"string"},"minutes":{"description":"Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).\nRequired when adding a reminder.","format":"int32","type":"integer"}}},"calendar_v3_EventWorkingLocationProperties":{"type":"object","properties":{"customLocation":{"description":"If present, specifies that the user is working from a custom location.","type":"object","properties":{"label":{"description":"An optional extra label for additional information.","type":"string"}}},"homeOffice":{"description":"If present, specifies that the user is working at home."},"officeLocation":{"description":"If present, specifies that the user is working from an office.","type":"object","properties":{"buildingId":{"description":"An optional building identifier. This should reference a building ID in the organization's Resources database.","type":"string"},"deskId":{"description":"An optional desk identifier.","type":"string"},"floorId":{"description":"An optional floor identifier.","type":"string"},"floorSectionId":{"description":"An optional floor section identifier.","type":"string"},"label":{"description":"The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database.","type":"string"}}},"type":{"description":"Type of the working location. Possible values are: \n- \"homeOffice\" - The user is working at home. \n- \"officeLocation\" - The user is working from an office. \n- \"customLocation\" - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Any other fields are ignored.\nRequired when adding working location properties.","type":"string"}}},"calendar_v3_Events":{"type":"object","properties":{"accessRole":{"description":"The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - The user has read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.","type":"string"},"defaultReminders":{"description":"The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventReminder"}},"description":{"description":"Description of the calendar. Read-only.","type":"string"},"etag":{"description":"ETag of the collection.","type":"string"},"items":{"description":"List of events on the calendar.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Event"}},"kind":{"description":"Type of the collection (\"calendar#events\").","default":"calendar#events","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"},"summary":{"description":"Title of the calendar. Read-only.","type":"string"},"timeZone":{"description":"The time zone of the calendar. Read-only.","type":"string"},"updated":{"description":"Last modification time of the calendar (as a RFC3339 timestamp). Read-only.","format":"date-time","type":"string"}}},"calendar_v3_FreeBusyCalendar":{"type":"object","properties":{"busy":{"description":"List of time ranges during which this calendar should be regarded as busy.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_TimePeriod"}},"errors":{"description":"Optional error(s) (if computation for the calendar failed).","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Error"}}}},"calendar_v3_FreeBusyGroup":{"type":"object","properties":{"calendars":{"description":"List of calendars' identifiers within a group.","type":"array","items":{"type":"string"}},"errors":{"description":"Optional error(s) (if computation for the group failed).","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Error"}}}},"calendar_v3_FreeBusyRequest":{"type":"object","properties":{"calendarExpansionMax":{"description":"Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.","format":"int32","type":"integer"},"groupExpansionMax":{"description":"Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.","format":"int32","type":"integer"},"items":{"description":"List of calendars and/or groups to query.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_FreeBusyRequestItem"}},"timeMax":{"description":"The end of the interval for the query formatted as per RFC3339.","format":"date-time","type":"string"},"timeMin":{"description":"The start of the interval for the query formatted as per RFC3339.","format":"date-time","type":"string"},"timeZone":{"description":"Time zone used in the response. Optional. The default is UTC.","default":"UTC","type":"string"}}},"calendar_v3_FreeBusyRequestItem":{"type":"object","properties":{"id":{"description":"The identifier of a calendar or a group.","type":"string"}}},"calendar_v3_FreeBusyResponse":{"type":"object","properties":{"calendars":{"description":"List of free/busy information for calendars.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_FreeBusyCalendar"}},"groups":{"description":"Expansion of groups.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_FreeBusyGroup"}},"kind":{"description":"Type of the resource (\"calendar#freeBusy\").","default":"calendar#freeBusy","type":"string"},"timeMax":{"description":"The end of the interval.","format":"date-time","type":"string"},"timeMin":{"description":"The start of the interval.","format":"date-time","type":"string"}}},"calendar_v3_LabelProperties":{"type":"object","properties":{"eventLabels":{"description":"Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels.\nExtend the list to add a new event label, and remove entities from the list to delete a label from calendar.\nEach calendar can have a maximum of 200 labels.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventLabel"}}}},"calendar_v3_Setting":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The id of the user setting.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#setting\").","default":"calendar#setting","type":"string"},"value":{"description":"Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.","type":"string"}}},"calendar_v3_Settings":{"type":"object","properties":{"etag":{"description":"Etag of the collection.","type":"string"},"items":{"description":"List of user settings.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Setting"}},"kind":{"description":"Type of the collection (\"calendar#settings\").","default":"calendar#settings","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"}}},"calendar_v3_TimePeriod":{"type":"object","properties":{"end":{"description":"The (exclusive) end of the time period.","format":"date-time","type":"string"},"start":{"description":"The (inclusive) start of the time period.","format":"date-time","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/calendar":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/calendar"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/calendar/v3/rest","service":"calendar","version":"v3"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Calendar API","version":"v3","description":"Manipulates events and other calendar data."},"servers":[{"url":"https://www.googleapis.com/calendar/v3/"}],"paths":{"/calendars":{"post":{"operationId":"calendar.calendars.insert","x-executor-toolPath":"calendar.calendars.insert","tags":["Calendar API"],"description":"Creates a secondary calendar.\nThe authenticated user for the request is made the data owner of the new calendar.\n\nNote: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior. For example, if a service account is the data owner, data ownership cannot be transferred.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendars"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendars","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}":{"get":{"operationId":"calendar.calendars.get","x-executor-toolPath":"calendar.calendars.get","tags":["Calendar API"],"description":"Returns metadata for a calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendars"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendars.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendars","https://www.googleapis.com/auth/calendar.calendars.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.calendars.update","x-executor-toolPath":"calendar.calendars.update","tags":["Calendar API"],"description":"Updates metadata for a calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendars"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendars","https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.calendars.delete","x-executor-toolPath":"calendar.calendars.delete","tags":["Calendar API"],"description":"Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendars"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendars","https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.calendars.patch","x-executor-toolPath":"calendar.calendars.patch","tags":["Calendar API"],"description":"Updates metadata for a calendar. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Calendar"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendars"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendars","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/acl":{"get":{"operationId":"calendar.acl.list","x-executor-toolPath":"calendar.acl.list","tags":["Calendar API"],"description":"Returns the rules in the access control list for the calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","schema":{"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Acl"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar.acls.readonly","https://www.googleapis.com/auth/calendar"]},"post":{"operationId":"calendar.acl.insert","x-executor-toolPath":"calendar.acl.insert","tags":["Calendar API"],"description":"Creates an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Whether to send notifications about the calendar sharing change. Optional. The default is True.","schema":{"description":"Whether to send notifications about the calendar sharing change. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/acl/watch":{"post":{"operationId":"calendar.acl.watch","x-executor-toolPath":"calendar.acl.watch","tags":["Calendar API"],"description":"Watch for changes to ACL resources.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","schema":{"description":"Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to \"none\". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar.acls.readonly","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/acl/{ruleId}":{"get":{"operationId":"calendar.acl.get","x-executor-toolPath":"calendar.acl.get","tags":["Calendar API"],"description":"Returns an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar.acls.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.acl.update","x-executor-toolPath":"calendar.acl.update","tags":["Calendar API"],"description":"Updates an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","schema":{"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.acl.delete","x-executor-toolPath":"calendar.acl.delete","tags":["Calendar API"],"description":"Deletes an access control rule.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.acl.patch","x-executor-toolPath":"calendar.acl.patch","tags":["Calendar API"],"description":"Updates an access control rule. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"ruleId","in":"path","required":true,"description":"ACL rule identifier.","schema":{"description":"ACL rule identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","schema":{"description":"Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_AclRule"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/clear":{"post":{"operationId":"calendar.calendars.clear","x-executor-toolPath":"calendar.calendars.clear","tags":["Calendar API"],"description":"Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendars"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.calendars","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events":{"get":{"operationId":"calendar.events.list","x-executor-toolPath":"calendar.events.list","tags":["Calendar API"],"description":"Returns events on the specified calendar.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored.","schema":{"description":"Deprecated and ignored.","type":"boolean"},"style":"form","explode":false},{"name":"eventTypes","in":"query","required":false,"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","schema":{"type":"array","items":{"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","enum":["birthday","default","focusTime","fromGmail","outOfOffice","workingLocation"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"iCalUID","in":"query","required":false,"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","schema":{"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","schema":{"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","format":"int32","default":250,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","schema":{"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","enum":["startTime","updated"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"privateExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"q","in":"query","required":false,"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","schema":{"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sharedExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","schema":{"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHiddenInvitations","in":"query","required":false,"description":"Whether to include hidden invitations in the result. Optional. The default is False.","schema":{"description":"Whether to include hidden invitations in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"singleEvents","in":"query","required":false,"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","schema":{"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"timeMax","in":"query","required":false,"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","schema":{"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeMin","in":"query","required":false,"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","schema":{"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"updatedMin","in":"query","required":false,"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","schema":{"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Events"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.public.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.freebusy","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar.events.owned.readonly","https://www.googleapis.com/auth/calendar.events.public.readonly","https://www.googleapis.com/auth/calendar.events.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]},"post":{"operationId":"calendar.events.insert","x-executor-toolPath":"calendar.events.insert","tags":["Calendar API"],"description":"Creates an event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.","schema":{"description":"Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/import":{"post":{"operationId":"calendar.events.import","x-executor-toolPath":"calendar.events.import","tags":["Calendar API"],"description":"Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported.\nDeprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/quickAdd":{"post":{"operationId":"calendar.events.quickAdd","x-executor-toolPath":"calendar.events.quickAdd","tags":["Calendar API"],"description":"Creates an event based on a simple text string.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the creation of the new event.","schema":{"description":"Guests who should receive notifications about the creation of the new event.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"text","in":"query","required":true,"description":"The text describing the event to be created.","schema":{"description":"The text describing the event to be created.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/watch":{"post":{"operationId":"calendar.events.watch","x-executor-toolPath":"calendar.events.watch","tags":["Calendar API"],"description":"Watch for changes to Events resources.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored.","schema":{"description":"Deprecated and ignored.","type":"boolean"},"style":"form","explode":false},{"name":"eventTypes","in":"query","required":false,"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","schema":{"type":"array","items":{"description":"Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.","enum":["birthday","default","focusTime","fromGmail","outOfOffice","workingLocation"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"iCalUID","in":"query","required":false,"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","schema":{"description":"Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","schema":{"description":"Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","format":"int32","default":250,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","schema":{"description":"The order of the events returned in the result. Optional. The default is an unspecified, stable order.","enum":["startTime","updated"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"privateExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"q","in":"query","required":false,"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","schema":{"description":"Free text search terms to find events that match these terms in the following fields:\n\n- summary \n- description \n- location \n- attendee's displayName \n- attendee's email \n- organizer's displayName \n- organizer's email \n- workingLocationProperties.officeLocation.buildingId \n- workingLocationProperties.officeLocation.deskId \n- workingLocationProperties.officeLocation.label \n- workingLocationProperties.customLocation.label \nThese search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for \"Office\" or \"Bureau\" returns working location events of type officeLocation, whereas searching for \"Out of office\" or \"Abwesend\" returns out-of-office events. Optional.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sharedExtendedProperty","in":"query","required":false,"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","schema":{"type":"array","items":{"description":"Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.","type":"string"}},"style":"form","explode":true},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","schema":{"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHiddenInvitations","in":"query","required":false,"description":"Whether to include hidden invitations in the result. Optional. The default is False.","schema":{"description":"Whether to include hidden invitations in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"singleEvents","in":"query","required":false,"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","schema":{"description":"Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.\nThere are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.\n\nThese are: \n- iCalUID \n- orderBy \n- privateExtendedProperty \n- q \n- sharedExtendedProperty \n- timeMin \n- timeMax \n- updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"timeMax","in":"query","required":false,"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","schema":{"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeMin","in":"query","required":false,"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","schema":{"description":"Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"updatedMin","in":"query","required":false,"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","schema":{"description":"Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.public.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.freebusy","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar.events.owned.readonly","https://www.googleapis.com/auth/calendar.events.public.readonly","https://www.googleapis.com/auth/calendar.events.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/{eventId}":{"get":{"operationId":"calendar.events.get","x-executor-toolPath":"calendar.events.get","tags":["Calendar API"],"description":"Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.public.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.freebusy","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar.events.owned.readonly","https://www.googleapis.com/auth/calendar.events.public.readonly","https://www.googleapis.com/auth/calendar.events.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.events.update","x-executor-toolPath":"calendar.events.update","tags":["Calendar API"],"description":"Updates an event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","schema":{"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.events.delete","x-executor-toolPath":"calendar.events.delete","tags":["Calendar API"],"description":"Deletes an event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the deletion of the event.","schema":{"description":"Guests who should receive notifications about the deletion of the event.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.events.patch","x-executor-toolPath":"calendar.events.patch","tags":["Calendar API"],"description":"Updates an event. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"conferenceDataVersion","in":"query","required":false,"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","schema":{"description":"Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"eventLabelVersion","in":"query","required":false,"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","schema":{"description":"Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","schema":{"description":"Guests who should receive notifications about the event update (for example, title changes, etc.).","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"supportsAttachments","in":"query","required":false,"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","schema":{"description":"Whether API client performing operation supports event attachments. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/{eventId}/instances":{"get":{"operationId":"calendar.events.instances","x-executor-toolPath":"calendar.events.instances","tags":["Calendar API"],"description":"Returns instances of the specified recurring event.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Recurring event identifier.","schema":{"description":"Recurring event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"alwaysIncludeEmail","in":"query","required":false,"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","schema":{"description":"Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxAttendees","in":"query","required":false,"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","schema":{"description":"The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","schema":{"description":"Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"originalStart","in":"query","required":false,"description":"The original start time of the instance in the result. Optional.","schema":{"description":"The original start time of the instance in the result. Optional.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.","schema":{"description":"Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"timeMax","in":"query","required":false,"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.","schema":{"description":"Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeMin","in":"query","required":false,"description":"Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.","schema":{"description":"Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.","format":"date-time","type":"string"},"style":"form","explode":false},{"name":"timeZone","in":"query","required":false,"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","schema":{"description":"Time zone used in the response. Optional. The default is the time zone of the calendar.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Events"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.public.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.freebusy","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar.events.owned.readonly","https://www.googleapis.com/auth/calendar.events.public.readonly","https://www.googleapis.com/auth/calendar.events.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]}},"/calendars/{calendarId}/events/{eventId}/move":{"post":{"operationId":"calendar.events.move","x-executor-toolPath":"calendar.events.move","tags":["Calendar API"],"description":"Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier of the source calendar where the event currently is on.","schema":{"description":"Calendar identifier of the source calendar where the event currently is on.","type":"string"}},{"name":"eventId","in":"path","required":true,"description":"Event identifier.","schema":{"description":"Event identifier.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"destination","in":"query","required":true,"description":"Calendar identifier of the target calendar where the event is to be moved to.","schema":{"description":"Calendar identifier of the target calendar where the event is to be moved to.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"sendNotifications","in":"query","required":false,"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.","schema":{"description":"Deprecated. Please use sendUpdates instead.\n\nWhether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.","type":"boolean"},"style":"form","explode":false},{"name":"sendUpdates","in":"query","required":false,"description":"Guests who should receive notifications about the change of the event's organizer.","schema":{"description":"Guests who should receive notifications about the change of the event's organizer.","enum":["all","externalOnly","none"],"type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Event"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar"]}},"/channels/stop":{"post":{"operationId":"calendar.channels.stop","x-executor-toolPath":"calendar.channels.stop","tags":["Calendar API"],"description":"Stop watching resources through this channel","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.acls.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.public.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.acls","https://www.googleapis.com/auth/calendar.acls.readonly","https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar.calendarlist.readonly","https://www.googleapis.com/auth/calendar.events","https://www.googleapis.com/auth/calendar.events.freebusy","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar.events.owned.readonly","https://www.googleapis.com/auth/calendar.events.public.readonly","https://www.googleapis.com/auth/calendar.events.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar.settings","https://www.googleapis.com/auth/calendar.settings.readonly","https://www.googleapis.com/auth/calendar"]}},"/colors":{"get":{"operationId":"calendar.colors.get","x-executor-toolPath":"calendar.colors.get","tags":["Calendar API"],"description":"Returns the color definitions for calendars and events.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Colors"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.owned.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.public.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar.calendarlist.readonly","https://www.googleapis.com/auth/calendar.events.freebusy","https://www.googleapis.com/auth/calendar.events.owned","https://www.googleapis.com/auth/calendar.events.owned.readonly","https://www.googleapis.com/auth/calendar.events.public.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]}},"/freeBusy":{"post":{"operationId":"calendar.freebusy.query","x-executor-toolPath":"calendar.freebusy.query","tags":["Calendar API"],"description":"Returns free/busy information for a set of calendars.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_FreeBusyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_FreeBusyResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.events.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.freebusy"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.events.freebusy","https://www.googleapis.com/auth/calendar.freebusy","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]}},"/users/me/calendarList":{"get":{"operationId":"calendar.calendarList.list","x-executor-toolPath":"calendar.calendarList.list","tags":["Calendar API"],"description":"Returns the calendars on the user's calendar list.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"minAccessRole","in":"query","required":false,"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","schema":{"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","enum":["freeBusyReader","owner","reader","writer","writerWithoutPrivateAccess"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","schema":{"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHidden","in":"query","required":false,"description":"Whether to show hidden entries. Optional. The default is False.","schema":{"description":"Whether to show hidden entries. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showOwnOrganizationOnly","in":"query","required":false,"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","schema":{"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar.calendarlist.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]},"post":{"operationId":"calendar.calendarList.insert","x-executor-toolPath":"calendar.calendarList.insert","tags":["Calendar API"],"description":"Inserts an existing calendar into the user's calendar list.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"colorRgbFormat","in":"query","required":false,"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","schema":{"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar"]}},"/users/me/calendarList/watch":{"post":{"operationId":"calendar.calendarList.watch","x-executor-toolPath":"calendar.calendarList.watch","tags":["Calendar API"],"description":"Watch for changes to CalendarList resources.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"minAccessRole","in":"query","required":false,"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","schema":{"description":"The minimum access role for the user in the returned entries. Optional. The default is no restriction.","enum":["freeBusyReader","owner","reader","writer","writerWithoutPrivateAccess"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","schema":{"description":"Whether to include deleted calendar list entries in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHidden","in":"query","required":false,"description":"Whether to show hidden entries. Optional. The default is False.","schema":{"description":"Whether to show hidden entries. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showOwnOrganizationOnly","in":"query","required":false,"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","schema":{"description":"Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar.calendarlist.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]}},"/users/me/calendarList/{calendarId}":{"get":{"operationId":"calendar.calendarList.get","x-executor-toolPath":"calendar.calendarList.get","tags":["Calendar API"],"description":"Returns a calendar from the user's calendar list.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar.calendarlist.readonly","https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar"]},"put":{"operationId":"calendar.calendarList.update","x-executor-toolPath":"calendar.calendarList.update","tags":["Calendar API"],"description":"Updates an existing calendar on the user's calendar list.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"colorRgbFormat","in":"query","required":false,"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","schema":{"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar"]},"delete":{"operationId":"calendar.calendarList.delete","x-executor-toolPath":"calendar.calendarList.delete","tags":["Calendar API"],"description":"Removes a calendar from the user's calendar list.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar"]},"patch":{"operationId":"calendar.calendarList.patch","x-executor-toolPath":"calendar.calendarList.patch","tags":["Calendar API"],"description":"Updates an existing calendar on the user's calendar list. This method supports patch semantics.","parameters":[{"name":"calendarId","in":"path","required":true,"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","schema":{"description":"Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"colorRgbFormat","in":"query","required":false,"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","schema":{"description":"Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.app.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.calendarlist"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.app.created","https://www.googleapis.com/auth/calendar.calendarlist","https://www.googleapis.com/auth/calendar"]}},"/users/me/settings":{"get":{"operationId":"calendar.settings.list","x-executor-toolPath":"calendar.settings.list","tags":["Calendar API"],"description":"Returns all user settings for the authenticated user.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Settings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar.settings","https://www.googleapis.com/auth/calendar.settings.readonly","https://www.googleapis.com/auth/calendar"]}},"/users/me/settings/watch":{"post":{"operationId":"calendar.settings.watch","x-executor-toolPath":"calendar.settings.watch","tags":["Calendar API"],"description":"Watch for changes to Settings resources.","parameters":[{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","schema":{"description":"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying which result page to return. Optional.","schema":{"description":"Token specifying which result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","schema":{"description":"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar.settings","https://www.googleapis.com/auth/calendar.settings.readonly","https://www.googleapis.com/auth/calendar"]}},"/users/me/settings/{setting}":{"get":{"operationId":"calendar.settings.get","x-executor-toolPath":"calendar.settings.get","tags":["Calendar API"],"description":"Returns a single user setting.","parameters":[{"name":"setting","in":"path","required":true,"description":"The id of the user setting.","schema":{"description":"The id of the user setting.","type":"string"}},{"name":"alt","in":"query","required":false,"description":"Data format for the response.","schema":{"description":"Data format for the response.","default":"json","enum":["json"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","schema":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","type":"string"},"style":"form","explode":false},{"name":"userIp","in":"query","required":false,"description":"Deprecated. Please use quotaUser instead.","schema":{"description":"Deprecated. Please use quotaUser instead.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calendar_v3_Setting"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/calendar.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar.settings.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/calendar"]}],"x-google-scopes":["https://www.googleapis.com/auth/calendar.readonly","https://www.googleapis.com/auth/calendar.settings","https://www.googleapis.com/auth/calendar.settings.readonly","https://www.googleapis.com/auth/calendar"]}}},"components":{"schemas":{"calendar_v3_Acl":{"type":"object","properties":{"etag":{"description":"ETag of the collection.","type":"string"},"items":{"description":"List of rules on the access control list.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_AclRule"}},"kind":{"description":"Type of the collection (\"calendar#acl\").","default":"calendar#acl","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"}}},"calendar_v3_AclRule":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"Identifier of the Access Control List (ACL) rule. See Sharing calendars.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#aclRule\").","default":"calendar#aclRule","type":"string"},"role":{"description":"The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.","type":"string"},"scope":{"description":"The extent to which calendar access is granted by this ACL rule.","type":"object","properties":{"type":{"description":"The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.","type":"string"},"value":{"description":"The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type \"default\".","type":"string"}}}}},"calendar_v3_Calendar":{"type":"object","properties":{"autoAcceptInvitations":{"description":"Whether this calendar automatically accepts invitations. Only valid for resource calendars.","type":"boolean"},"conferenceProperties":{"$ref":"#/components/schemas/calendar_v3_ConferenceProperties"},"dataOwner":{"description":"The email of the owner of the calendar. Set only for secondary calendars. Read-only.","type":"string"},"description":{"description":"Description of the calendar. Optional.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"Identifier of the calendar. To retrieve IDs call the calendarList.list() method.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#calendar\").","default":"calendar#calendar","type":"string"},"labelProperties":{"$ref":"#/components/schemas/calendar_v3_LabelProperties"},"location":{"description":"Geographic location of the calendar as free-form text. Optional.","type":"string"},"summary":{"description":"Title of the calendar.","type":"string"},"timeZone":{"description":"The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) Optional.","type":"string"}}},"calendar_v3_CalendarList":{"type":"object","properties":{"etag":{"description":"ETag of the collection.","type":"string"},"items":{"description":"Calendars that are present on the user's calendar list.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_CalendarListEntry"}},"kind":{"description":"Type of the collection (\"calendar#calendarList\").","default":"calendar#calendarList","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"}}},"calendar_v3_CalendarListEntry":{"type":"object","properties":{"accessRole":{"description":"The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.","type":"string"},"autoAcceptInvitations":{"description":"Whether this calendar automatically accepts invitations. Only valid for resource calendars. Read-only.","type":"boolean"},"backgroundColor":{"description":"The main color of the calendar in the hexadecimal format \"#0088aa\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.","type":"string"},"colorId":{"description":"The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.","type":"string"},"conferenceProperties":{"$ref":"#/components/schemas/calendar_v3_ConferenceProperties"},"dataOwner":{"description":"The email of the owner of the calendar. Set only for secondary calendars. Read-only.","type":"string"},"defaultReminders":{"description":"The default reminders that the authenticated user has for this calendar.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventReminder"}},"deleted":{"description":"Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.","default":false,"type":"boolean"},"description":{"description":"Description of the calendar. Optional. Read-only.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"foregroundColor":{"description":"The foreground color of the calendar in the hexadecimal format \"#ffffff\". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.","type":"string"},"hidden":{"description":"Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.","default":false,"type":"boolean"},"id":{"description":"Identifier of the calendar.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#calendarListEntry\").","default":"calendar#calendarListEntry","type":"string"},"location":{"description":"Geographic location of the calendar as free-form text. Optional. Read-only.","type":"string"},"notificationSettings":{"description":"The notifications that the authenticated user is receiving for this calendar.","type":"object","properties":{"notifications":{"description":"The list of notifications set for this calendar.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_CalendarNotification"}}}},"primary":{"description":"Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.","default":false,"type":"boolean"},"selected":{"description":"Whether the calendar content shows up in the calendar UI. Optional. The default is False.","default":false,"type":"boolean"},"summary":{"description":"Title of the calendar. Read-only.","type":"string"},"summaryOverride":{"description":"The summary that the authenticated user has set for this calendar. Optional.","type":"string"},"timeZone":{"description":"The time zone of the calendar. Optional. Read-only.","type":"string"}}},"calendar_v3_CalendarNotification":{"type":"object","properties":{"method":{"description":"The method used to deliver the notification. The possible value is: \n- \"email\" - Notifications are sent via email. \nRequired when adding a notification.","type":"string"},"type":{"description":"The type of notification. Possible values are: \n- \"eventCreation\" - Notification sent when a new event is put on the calendar. \n- \"eventChange\" - Notification sent when an event is changed. \n- \"eventCancellation\" - Notification sent when an event is cancelled. \n- \"eventResponse\" - Notification sent when an attendee responds to the event invitation. \n- \"agenda\" - An agenda with the events of the day (sent out in the morning). \nRequired when adding a notification.","type":"string"}}},"calendar_v3_Channel":{"type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional.","type":"object","additionalProperties":{"description":"Declares a new parameter by name.","type":"string"}},"payload":{"description":"A Boolean value to indicate whether payload is wanted. Optional.","type":"boolean"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.","type":"string"}}},"calendar_v3_ColorDefinition":{"type":"object","properties":{"background":{"description":"The background color associated with this color definition.","type":"string"},"foreground":{"description":"The foreground color that can be used to write on top of a background with 'background' color.","type":"string"}}},"calendar_v3_Colors":{"type":"object","properties":{"calendar":{"description":"A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_ColorDefinition"}},"event":{"description":"A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_ColorDefinition"}},"kind":{"description":"Type of the resource (\"calendar#colors\").","default":"calendar#colors","type":"string"},"updated":{"description":"Last modification time of the color palette (as a RFC3339 timestamp). Read-only.","format":"date-time","type":"string"}}},"calendar_v3_ConferenceData":{"type":"object","properties":{"conferenceId":{"description":"The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nThe ID value is formed differently for each conference solution type: \n- eventHangout: ID is not set. (This conference type is deprecated.)\n- eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)\n- hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.\n- addOn: ID is defined by the third-party provider. Optional.","type":"string"},"conferenceSolution":{"$ref":"#/components/schemas/calendar_v3_ConferenceSolution"},"createRequest":{"$ref":"#/components/schemas/calendar_v3_CreateConferenceRequest"},"entryPoints":{"description":"Information about individual conference entry points, such as URLs or phone numbers.\nAll of them must belong to the same conference.\nEither conferenceSolution and at least one entryPoint, or createRequest is required.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EntryPoint"}},"notes":{"description":"Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.","type":"string"},"parameters":{"$ref":"#/components/schemas/calendar_v3_ConferenceParameters"},"signature":{"description":"The signature of the conference data.\nGenerated on server side.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request.","type":"string"}}},"calendar_v3_ConferenceParameters":{"type":"object","properties":{"addOnParameters":{"$ref":"#/components/schemas/calendar_v3_ConferenceParametersAddOnParameters"}}},"calendar_v3_ConferenceParametersAddOnParameters":{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"calendar_v3_ConferenceProperties":{"type":"object","properties":{"allowedConferenceSolutionTypes":{"description":"The types of conference solutions that are supported for this calendar.\nThe possible values are: \n- \"eventHangout\" \n- \"eventNamedHangout\" \n- \"hangoutsMeet\" Optional.","type":"array","items":{"type":"string"}}}},"calendar_v3_ConferenceRequestStatus":{"type":"object","properties":{"statusCode":{"description":"The current status of the conference create request. Read-only.\nThe possible values are: \n- \"pending\": the conference create request is still being processed.\n- \"success\": the conference create request succeeded, the entry points are populated.\n- \"failure\": the conference create request failed, there are no entry points.","type":"string"}}},"calendar_v3_ConferenceSolution":{"type":"object","properties":{"iconUri":{"description":"The user-visible icon for this solution.","type":"string"},"key":{"$ref":"#/components/schemas/calendar_v3_ConferenceSolutionKey"},"name":{"description":"The user-visible name of this solution. Not localized.","type":"string"}}},"calendar_v3_ConferenceSolutionKey":{"type":"object","properties":{"type":{"description":"The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"eventNamedHangout\" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers","type":"string"}}},"calendar_v3_CreateConferenceRequest":{"type":"object","properties":{"conferenceSolutionKey":{"$ref":"#/components/schemas/calendar_v3_ConferenceSolutionKey"},"requestId":{"description":"The client-generated unique ID for this request.\nClients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.","type":"string"},"status":{"$ref":"#/components/schemas/calendar_v3_ConferenceRequestStatus"}}},"calendar_v3_EntryPoint":{"type":"object","properties":{"accessCode":{"description":"The access code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"entryPointFeatures":{"description":"Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.","type":"array","items":{"type":"string"}},"entryPointType":{"description":"The type of the conference entry point.\nPossible values are: \n- \"video\" - joining a conference over HTTP. A conference can have zero or one video entry point.\n- \"phone\" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.\n- \"sip\" - joining a conference over SIP. A conference can have zero or one sip entry point.\n- \"more\" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.","type":"string"},"label":{"description":"The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.\nExamples: \n- for video: meet.google.com/aaa-bbbb-ccc\n- for phone: +1 123 268 2601\n- for sip: 12345678@altostrat.com\n- for more: should not be filled \nOptional.","type":"string"},"meetingCode":{"description":"The meeting code to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"passcode":{"description":"The passcode to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.","type":"string"},"password":{"description":"The password to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"pin":{"description":"The PIN to access the conference. The maximum length is 128 characters.\nWhen creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.\nOptional.","type":"string"},"regionCode":{"description":"The CLDR/ISO 3166 region code for the country associated with this phone access. Example: \"SE\" for Sweden.\nCalendar backend will populate this field only for EntryPointType.PHONE.","type":"string"},"uri":{"description":"The URI of the entry point. The maximum length is 1300 characters.\nFormat: \n- for video, http: or https: schema is required.\n- for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).\n- for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.\n- for more, http: or https: schema is required.","type":"string"}}},"calendar_v3_Error":{"type":"object","properties":{"domain":{"description":"Domain, or broad category, of the error.","type":"string"},"reason":{"description":"Specific reason for the error. Some of the possible values are: \n- \"groupTooBig\" - The group of users requested is too large for a single query. \n- \"tooManyCalendarsRequested\" - The number of calendars requested is too large for a single query. \n- \"notFound\" - The requested resource was not found. \n- \"internalError\" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.","type":"string"}}},"calendar_v3_Event":{"type":"object","properties":{"anyoneCanAddSelf":{"description":"Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.","default":false,"type":"boolean"},"attachments":{"description":"File attachments for the event.\nIn order to modify attachments the supportsAttachments request parameter should be set to true.\nThere can be at most 25 attachments per event,","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventAttachment"}},"attendees":{"description":"The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventAttendee"}},"attendeesOmitted":{"description":"Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.","default":false,"type":"boolean"},"birthdayProperties":{"$ref":"#/components/schemas/calendar_v3_EventBirthdayProperties"},"colorId":{"description":"The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.","type":"string"},"conferenceData":{"$ref":"#/components/schemas/calendar_v3_ConferenceData"},"created":{"description":"Creation time of the event (as a RFC3339 timestamp). Read-only.","format":"date-time","type":"string"},"creator":{"description":"The creator of the event. Read-only.","type":"object","properties":{"displayName":{"description":"The creator's name, if available.","type":"string"},"email":{"description":"The creator's email address, if available.","type":"string"},"id":{"description":"The creator's Profile ID, if available.","type":"string"},"self":{"description":"Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.","default":false,"type":"boolean"}}},"description":{"description":"Description of the event. Can contain HTML. Optional.","type":"string"},"end":{"$ref":"#/components/schemas/calendar_v3_EventDateTime"},"endTimeUnspecified":{"description":"Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.","default":false,"type":"boolean"},"etag":{"description":"ETag of the resource.","type":"string"},"eventLabelId":{"description":"The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.)\nThis property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods.\nSetting an empty string, or not setting this field at all, will remove the existing label from the event.","type":"string"},"eventType":{"description":"Specific type of the event. This cannot be modified after the event is created. Possible values are: \n- \"birthday\" - A special all-day event with an annual recurrence. \n- \"default\" - A regular event or not further specified. \n- \"focusTime\" - A focus-time event. \n- \"fromGmail\" - An event from Gmail. This type of event cannot be created. \n- \"outOfOffice\" - An out-of-office event. \n- \"workingLocation\" - A working location event.","default":"default","type":"string"},"extendedProperties":{"description":"Extended properties of the event.","type":"object","properties":{"private":{"description":"Properties that are private to the copy of the event that appears on this calendar.","type":"object","additionalProperties":{"description":"The name of the private property and the corresponding value.","type":"string"}},"shared":{"description":"Properties that are shared between copies of the event on other attendees' calendars.","type":"object","additionalProperties":{"description":"The name of the shared property and the corresponding value.","type":"string"}}}},"focusTimeProperties":{"$ref":"#/components/schemas/calendar_v3_EventFocusTimeProperties"},"gadget":{"description":"A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.","type":"object","properties":{"display":{"description":"The gadget's display mode. Deprecated. Possible values are: \n- \"icon\" - The gadget displays next to the event's title in the calendar view. \n- \"chip\" - The gadget displays when the event is clicked.","type":"string"},"height":{"description":"The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated.","format":"int32","type":"integer"},"iconLink":{"description":"The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.","type":"string"},"link":{"description":"The gadget's URL. The URL scheme must be HTTPS. Deprecated.","type":"string"},"preferences":{"description":"Preferences.","type":"object","additionalProperties":{"description":"The preference name and corresponding value.","type":"string"}},"title":{"description":"The gadget's title. Deprecated.","type":"string"},"type":{"description":"The gadget's type. Deprecated.","type":"string"},"width":{"description":"The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated.","format":"int32","type":"integer"}}},"guestsCanInviteOthers":{"description":"Whether attendees other than the organizer can invite others to the event. Optional. The default is True.","default":true,"type":"boolean"},"guestsCanModify":{"description":"Whether attendees other than the organizer can modify the event. Optional. The default is False.","default":false,"type":"boolean"},"guestsCanSeeOtherGuests":{"description":"Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.","default":true,"type":"boolean"},"hangoutLink":{"description":"An absolute link to the Google Hangout associated with this event. Read-only.","type":"string"},"htmlLink":{"description":"An absolute link to this event in the Google Calendar Web UI. Read-only.","type":"string"},"iCalUID":{"description":"Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.\nNote that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.","type":"string"},"id":{"description":"Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: \n- characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 \n- the length of the ID must be between 5 and 1024 characters \n- the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.\nIf you do not specify an ID, it will be automatically generated by the server.\nNote that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#event\").","default":"calendar#event","type":"string"},"location":{"description":"Geographic location of the event as free-form text. Optional.","type":"string"},"locked":{"description":"Whether this is a locked event copy where no changes can be made to the main event fields \"summary\", \"description\", \"location\", \"start\", \"end\" or \"recurrence\". The default is False. Read-Only.","default":false,"type":"boolean"},"organizer":{"description":"The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.","type":"object","properties":{"displayName":{"description":"The organizer's name, if available.","type":"string"},"email":{"description":"The organizer's email address, if available. It must be a valid email address as per RFC5322.","type":"string"},"id":{"description":"The organizer's Profile ID, if available.","type":"string"},"self":{"description":"Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.","default":false,"type":"boolean"}}},"originalStartTime":{"$ref":"#/components/schemas/calendar_v3_EventDateTime"},"outOfOfficeProperties":{"$ref":"#/components/schemas/calendar_v3_EventOutOfOfficeProperties"},"privateCopy":{"description":"If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.","default":false,"type":"boolean"},"recurrence":{"description":"List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.","type":"array","items":{"type":"string"}},"recurringEventId":{"description":"For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.","type":"string"},"reminders":{"description":"Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.","type":"object","properties":{"overrides":{"description":"If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventReminder"}},"useDefault":{"description":"Whether the default reminders of the calendar apply to the event.","type":"boolean"}}},"sequence":{"description":"Sequence number as per iCalendar.","format":"int32","type":"integer"},"source":{"description":"Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.","type":"object","properties":{"title":{"description":"Title of the source; for example a title of a web page or an email subject.","type":"string"},"url":{"description":"URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.","type":"string"}}},"start":{"$ref":"#/components/schemas/calendar_v3_EventDateTime"},"status":{"description":"Status of the event. Optional. Possible values are: \n- \"confirmed\" - The event is confirmed. This is the default status. \n- \"tentative\" - The event is tentatively confirmed. \n- \"cancelled\" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.\nA cancelled status represents two different states depending on the event type: \n- Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.\nCancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. \n- All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.\nDeleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.\nIf an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.","type":"string"},"summary":{"description":"Title of the event.","type":"string"},"transparency":{"description":"Whether the event blocks time on the calendar. Optional. Possible values are: \n- \"opaque\" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. \n- \"transparent\" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.","default":"opaque","type":"string"},"updated":{"description":"Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.","format":"date-time","type":"string"},"visibility":{"description":"Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons. \nNote on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event.","default":"default","type":"string"},"workingLocationProperties":{"$ref":"#/components/schemas/calendar_v3_EventWorkingLocationProperties"}}},"calendar_v3_EventAttachment":{"type":"object","properties":{"fileId":{"description":"ID of the attached file. Read-only.\nFor Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.","type":"string"},"fileUrl":{"description":"URL link to the attachment.\nFor adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.\nRequired when adding an attachment.","type":"string"},"iconLink":{"description":"URL link to the attachment's icon. This field can only be modified for custom third-party attachments.","type":"string"},"mimeType":{"description":"Internet media type (MIME type) of the attachment.","type":"string"},"title":{"description":"Attachment title.","type":"string"}}},"calendar_v3_EventAttendee":{"type":"object","properties":{"additionalGuests":{"description":"Number of additional guests. Optional. The default is 0.","format":"int32","default":0,"type":"integer"},"asyncOperation":{"description":"If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present.\nPossible values are: \n- \"inProgress\" - The asynchronous operation is in progress. \n- (not present) - Otherwise.","default":"","type":"string"},"comment":{"description":"The attendee's response comment. Optional.","type":"string"},"displayName":{"description":"The attendee's name, if available. Optional.","type":"string"},"email":{"description":"The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.\nRequired when adding an attendee.","type":"string"},"id":{"description":"The attendee's Profile ID, if available.","type":"string"},"optional":{"description":"Whether this is an optional attendee. Optional. The default is False.","default":false,"type":"boolean"},"organizer":{"description":"Whether the attendee is the organizer of the event. Read-only. The default is False.","type":"boolean"},"resource":{"description":"Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.","default":false,"type":"boolean"},"responseStatus":{"description":"The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation (recommended for new events). \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the \"Add invitations to my calendar\" setting set to \"When I respond to invitation in email\" or \"Only if the sender is known\" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests.","type":"string"},"self":{"description":"Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.","default":false,"type":"boolean"}}},"calendar_v3_EventBirthdayProperties":{"type":"object","properties":{"contact":{"description":"Resource name of the contact this birthday event is linked to. This can be used to fetch contact details from People API. Format: \"people/c12345\". Read-only.","type":"string"},"customTypeName":{"description":"Custom type label specified for this event. This is populated if birthdayProperties.type is set to \"custom\". Read-only.","type":"string"},"type":{"description":"Type of birthday or special event. Possible values are: \n- \"anniversary\" - An anniversary other than birthday. Always has a contact. \n- \"birthday\" - A birthday event. This is the default value. \n- \"custom\" - A special date whose label is further specified in the customTypeName field. Always has a contact. \n- \"other\" - A special date which does not fall into the other categories, and does not have a custom label. Always has a contact. \n- \"self\" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type \"birthday\". The type cannot be changed after the event is created.","default":"birthday","type":"string"}}},"calendar_v3_EventDateTime":{"type":"object","properties":{"date":{"description":"The date, in the format \"yyyy-mm-dd\", if this is an all-day event.","format":"date","type":"string"},"dateTime":{"description":"The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.","format":"date-time","type":"string"},"timeZone":{"description":"The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. \"Europe/Zurich\".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.","type":"string"}}},"calendar_v3_EventFocusTimeProperties":{"type":"object","properties":{"autoDeclineMode":{"description":"Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined.","type":"string"},"chatStatus":{"description":"The status to mark the user in Chat and related products. This can be available or doNotDisturb.","type":"string"},"declineMessage":{"description":"Response message to set if an existing event or new invitation is automatically declined by Calendar.","type":"string"}}},"calendar_v3_EventLabel":{"type":"object","properties":{"backgroundColor":{"description":"Background color of the label in hexadecimal format, such as \"#039be5\". Events with this label are displayed in this color. Required.","type":"string"},"id":{"description":"The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label.\nIf provided, the ID must be unique within the calendar and follow UUID format.","type":"string"},"name":{"description":"Name of the label. Optional.\nIf provided this must have at most 50 characters.","type":"string"}}},"calendar_v3_EventOutOfOfficeProperties":{"type":"object","properties":{"autoDeclineMode":{"description":"Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined.","type":"string"},"declineMessage":{"description":"Response message to set if an existing event or new invitation is automatically declined by Calendar.","type":"string"}}},"calendar_v3_EventReminder":{"type":"object","properties":{"method":{"description":"The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"popup\" - Reminders are sent via a UI popup. \nRequired when adding a reminder.","type":"string"},"minutes":{"description":"Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).\nRequired when adding a reminder.","format":"int32","type":"integer"}}},"calendar_v3_EventWorkingLocationProperties":{"type":"object","properties":{"customLocation":{"description":"If present, specifies that the user is working from a custom location.","type":"object","properties":{"label":{"description":"An optional extra label for additional information.","type":"string"}}},"homeOffice":{"description":"If present, specifies that the user is working at home."},"officeLocation":{"description":"If present, specifies that the user is working from an office.","type":"object","properties":{"buildingId":{"description":"An optional building identifier. This should reference a building ID in the organization's Resources database.","type":"string"},"deskId":{"description":"An optional desk identifier.","type":"string"},"floorId":{"description":"An optional floor identifier.","type":"string"},"floorSectionId":{"description":"An optional floor section identifier.","type":"string"},"label":{"description":"The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database.","type":"string"}}},"type":{"description":"Type of the working location. Possible values are: \n- \"homeOffice\" - The user is working at home. \n- \"officeLocation\" - The user is working from an office. \n- \"customLocation\" - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Any other fields are ignored.\nRequired when adding working location properties.","type":"string"}}},"calendar_v3_Events":{"type":"object","properties":{"accessRole":{"description":"The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - The user has read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.","type":"string"},"defaultReminders":{"description":"The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventReminder"}},"description":{"description":"Description of the calendar. Read-only.","type":"string"},"etag":{"description":"ETag of the collection.","type":"string"},"items":{"description":"List of events on the calendar.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Event"}},"kind":{"description":"Type of the collection (\"calendar#events\").","default":"calendar#events","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"},"summary":{"description":"Title of the calendar. Read-only.","type":"string"},"timeZone":{"description":"The time zone of the calendar. Read-only.","type":"string"},"updated":{"description":"Last modification time of the calendar (as a RFC3339 timestamp). Read-only.","format":"date-time","type":"string"}}},"calendar_v3_FreeBusyCalendar":{"type":"object","properties":{"busy":{"description":"List of time ranges during which this calendar should be regarded as busy.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_TimePeriod"}},"errors":{"description":"Optional error(s) (if computation for the calendar failed).","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Error"}}}},"calendar_v3_FreeBusyGroup":{"type":"object","properties":{"calendars":{"description":"List of calendars' identifiers within a group.","type":"array","items":{"type":"string"}},"errors":{"description":"Optional error(s) (if computation for the group failed).","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Error"}}}},"calendar_v3_FreeBusyRequest":{"type":"object","properties":{"calendarExpansionMax":{"description":"Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.","format":"int32","type":"integer"},"groupExpansionMax":{"description":"Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.","format":"int32","type":"integer"},"items":{"description":"List of calendars and/or groups to query.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_FreeBusyRequestItem"}},"timeMax":{"description":"The end of the interval for the query formatted as per RFC3339.","format":"date-time","type":"string"},"timeMin":{"description":"The start of the interval for the query formatted as per RFC3339.","format":"date-time","type":"string"},"timeZone":{"description":"Time zone used in the response. Optional. The default is UTC.","default":"UTC","type":"string"}}},"calendar_v3_FreeBusyRequestItem":{"type":"object","properties":{"id":{"description":"The identifier of a calendar or a group.","type":"string"}}},"calendar_v3_FreeBusyResponse":{"type":"object","properties":{"calendars":{"description":"List of free/busy information for calendars.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_FreeBusyCalendar"}},"groups":{"description":"Expansion of groups.","type":"object","additionalProperties":{"$ref":"#/components/schemas/calendar_v3_FreeBusyGroup"}},"kind":{"description":"Type of the resource (\"calendar#freeBusy\").","default":"calendar#freeBusy","type":"string"},"timeMax":{"description":"The end of the interval.","format":"date-time","type":"string"},"timeMin":{"description":"The start of the interval.","format":"date-time","type":"string"}}},"calendar_v3_LabelProperties":{"type":"object","properties":{"eventLabels":{"description":"Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels.\nExtend the list to add a new event label, and remove entities from the list to delete a label from calendar.\nEach calendar can have a maximum of 200 labels.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_EventLabel"}}}},"calendar_v3_Setting":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"The id of the user setting.","type":"string"},"kind":{"description":"Type of the resource (\"calendar#setting\").","default":"calendar#setting","type":"string"},"value":{"description":"Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.","type":"string"}}},"calendar_v3_Settings":{"type":"object","properties":{"etag":{"description":"Etag of the collection.","type":"string"},"items":{"description":"List of user settings.","type":"array","items":{"$ref":"#/components/schemas/calendar_v3_Setting"}},"kind":{"description":"Type of the collection (\"calendar#settings\").","default":"calendar#settings","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.","type":"string"},"nextSyncToken":{"description":"Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.","type":"string"}}},"calendar_v3_TimePeriod":{"type":"object","properties":{"end":{"description":"The (exclusive) end of the time period.","format":"date-time","type":"string"},"start":{"description":"The (inclusive) start of the time period.","format":"date-time","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/calendar":"See, edit, share, and permanently delete all the calendars you can access using Google Calendar","https://www.googleapis.com/auth/calendar.calendarlist":"See, add, and remove Google calendars you’re subscribed to","https://www.googleapis.com/auth/calendar.calendarlist.readonly":"See the list of Google calendars you’re subscribed to","https://www.googleapis.com/auth/calendar.readonly":"See and download any calendar you can access using your Google Calendar","https://www.googleapis.com/auth/calendar.app.created":"Make secondary Google calendars, and see, create, change, and delete events on them","https://www.googleapis.com/auth/calendar.settings":"View and edit your Calendar settings","https://www.googleapis.com/auth/calendar.settings.readonly":"View your Calendar settings","https://www.googleapis.com/auth/calendar.events":"View and edit events on all your calendars","https://www.googleapis.com/auth/calendar.events.owned":"See, create, change, and delete events on Google calendars you own","https://www.googleapis.com/auth/calendar.events.freebusy":"See the availability on Google calendars you have access to","https://www.googleapis.com/auth/calendar.events.owned.readonly":"See the events on Google calendars you own","https://www.googleapis.com/auth/calendar.events.public.readonly":"See the events on public calendars","https://www.googleapis.com/auth/calendar.events.readonly":"View events on all your calendars","https://www.googleapis.com/auth/calendar.acls":"See and change the sharing permissions of Google calendars you own","https://www.googleapis.com/auth/calendar.acls.readonly":"See the sharing permissions of Google calendars you own","https://www.googleapis.com/auth/calendar.calendars":"See and change the properties of Google calendars you have access to, and create secondary calendars","https://www.googleapis.com/auth/calendar.calendars.readonly":"See the title, description, default time zone, and other properties of Google calendars you have access to","https://www.googleapis.com/auth/calendar.freebusy":"View your availability in your calendars"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/calendar"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/calendar/v3/rest","service":"calendar","version":"v3"}]}} \ No newline at end of file diff --git a/public/specs/google/google-chat.json b/public/specs/google/google-chat.json index 5736530e..f7d36a12 100644 --- a/public/specs/google/google-chat.json +++ b/public/specs/google/google-chat.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Chat API","version":"v1","description":"The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages."},"servers":[{"url":"https://chat.googleapis.com/"}],"paths":{"/upload/v1/{parent}/attachments:upload":{"post":{"operationId":"chat.media.uploadMedia","x-executor-toolPath":"chat.media.uploadMedia","tags":["Google Chat API"],"description":"Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat). (media upload)","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","schema":{"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_UploadAttachmentResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/customEmojis":{"get":{"operationId":"chat.customEmojis.list","x-executor-toolPath":"chat.customEmojis.list","tags":["Google Chat API"],"description":"Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: ``` creator(\"users/me\") ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: ``` creator(\"users/me\") ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","schema":{"description":"Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","schema":{"description":"Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListCustomEmojisResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis"]},"post":{"operationId":"chat.customEmojis.create","x-executor-toolPath":"chat.customEmojis.create","tags":["Google Chat API"],"description":"Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis"]}},"/v1/customEmojis/{customEmojisId}":{"get":{"operationId":"chat.customEmojis.get","x-executor-toolPath":"chat.customEmojis.get","tags":["Google Chat API"],"description":"Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"customEmojisId","in":"path","required":true,"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","schema":{"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis"]},"delete":{"operationId":"chat.customEmojis.delete","x-executor-toolPath":"chat.customEmojis.delete","tags":["Google Chat API"],"description":"Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"customEmojisId","in":"path","required":true,"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","schema":{"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis"]}},"/v1/media/{resourceName}":{"get":{"operationId":"chat.media.download","x-executor-toolPath":"chat.media.download","tags":["Google Chat API"],"description":"Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Name of the media that is being downloaded. See ReadRequest.resource_name.","schema":{"description":"Name of the media that is being downloaded. See ReadRequest.resource_name.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Media"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces":{"get":{"operationId":"chat.spaces.list","x-executor-toolPath":"chat.spaces.list","tags":["Google Chat API"],"description":"Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = \"SPACE\" spaceType = \"GROUP_CHAT\" OR spaceType = \"DIRECT_MESSAGE\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = \"SPACE\" spaceType = \"GROUP_CHAT\" OR spaceType = \"DIRECT_MESSAGE\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSpacesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]},"post":{"operationId":"chat.spaces.create","x-executor-toolPath":"chat.spaces.create","tags":["Google Chat API"],"description":"Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces.create` - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When authenticating as an app, the `space.customer` field must be set in the request. When authenticating as an app, the Chat app is added as a member of the space. However, unlike human authentication, the Chat app is not added as a space manager. By default, the Chat app can be removed from the space by all space members. To allow only space managers to remove the app from a space, set `space.permission_settings.manage_apps` to `managers_allowed`. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":false,"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.","schema":{"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces/{spacesId}":{"get":{"operationId":"chat.spaces.get","x-executor-toolPath":"chat.spaces.get","tags":["Google Chat API"],"description":"Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - `space.access_settings` is only populated when using the `chat.app.spaces` scope. - `space.predefind_permission_settings` and `space.permission_settings` are only populated when using the `chat.app.spaces` scope, and only for spaces the app created.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]},"delete":{"operationId":"chat.spaces.delete","x-executor-toolPath":"chat.spaces.delete","tags":["Google Chat API"],"description":"Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.delete` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.delete` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.delete`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space to delete. Format: `spaces/{space}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space to delete. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.delete"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.delete"]},"patch":{"operationId":"chat.spaces.patch","x-executor-toolPath":"chat.spaces.patch","tags":["Google Chat API"],"description":"Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - To update either `space.predefined_permission_settings` or `space.permission_settings`, the app must be the space creator. - Updating the `space.access_settings.audience` is not supported for app authentication.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership`","schema":{"description":"Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces/{spacesId}/members/{membersId}":{"get":{"operationId":"chat.spaces.members.get","x-executor-toolPath":"chat.spaces.members.get","tags":["Google Chat API"],"description":"Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]},"delete":{"operationId":"chat.spaces.members.delete","x-executor-toolPath":"chat.spaces.members.delete","tags":["Google Chat API"],"description":"Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to remove the calling app from the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Removing a Google Group from a space. - Removing a Chat app from a space. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the Chat app must be the space creator.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]},"patch":{"operationId":"chat.spaces.members.patch","x-executor-toolPath":"chat.spaces.members.patch","tags":["Google Chat API"],"description":"Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role`","schema":{"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]}},"/v1/spaces/{spacesId}/messagePins/{messagePinsId}":{"delete":{"operationId":"chat.spaces.messagePins.delete","x-executor-toolPath":"chat.spaces.messagePins.delete","tags":["Google Chat API"],"description":"Deletes a message pin. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","type":"string"},"allowReserved":true},{"name":"messagePinsId","in":"path","required":true,"description":"`messagePinsId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","schema":{"description":"`messagePinsId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces/{spacesId}/messages/{messagesId}":{"get":{"operationId":"chat.spaces.messages.get","x-executor-toolPath":"chat.spaces.messages.get","tags":["Google Chat API"],"description":"Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"markupSyntax","in":"query","required":false,"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","schema":{"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]},"delete":{"operationId":"chat.spaces.messages.delete","x-executor-toolPath":"chat.spaces.messages.delete","tags":["Google Chat API"],"description":"Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"force","in":"query","required":false,"description":"Optional. When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).","schema":{"description":"Optional. When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]},"patch":{"operationId":"chat.spaces.messages.patch","x-executor-toolPath":"chat.spaces.messages.patch","tags":["Google Chat API"],"description":"Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allowMissing","in":"query","required":false,"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","schema":{"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","schema":{"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}":{"delete":{"operationId":"chat.spaces.messages.reactions.delete","x-executor-toolPath":"chat.spaces.messages.reactions.delete","tags":["Google Chat API"],"description":"Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"allowReserved":true},{"name":"reactionsId","in":"path","required":true,"description":"`reactionsId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","schema":{"description":"`reactionsId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}":{"get":{"operationId":"chat.spaces.spaceEvents.get","x-executor-toolPath":"chat.spaces.spaceEvents.get","tags":["Google Chat API"],"description":"Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","type":"string"},"allowReserved":true},{"name":"spaceEventsId","in":"path","required":true,"description":"`spaceEventsId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","schema":{"description":"`spaceEventsId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceEvent"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces","https://www.googleapis.com/auth/chat.memberships","https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces:findDirectMessage":{"get":{"operationId":"chat.spaces.findDirectMessage","x-executor-toolPath":"chat.spaces.findDirectMessage","tags":["Google Chat API"],"description":"Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"name","in":"query","required":false,"description":"Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"description":"Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces:findGroupChats":{"get":{"operationId":"chat.spaces.findGroupChats","x-executor-toolPath":"chat.spaces.findGroupChats","tags":["Google Chat API"],"description":"Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/workspace/chat/find-group-chats). If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"spaceView","in":"query","required":false,"description":"Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.","schema":{"description":"Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.","enum":["SPACE_VIEW_UNSPECIFIED","SPACE_VIEW_RESOURCE_NAME_ONLY","SPACE_VIEW_EXPANDED"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"users","in":"query","required":false,"description":"Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"type":"array","items":{"description":"Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_FindGroupChatsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]}},"/v1/spaces:search":{"get":{"operationId":"chat.spaces.search","x-executor-toolPath":"chat.spaces.search","tags":["Google Chat API"],"description":"Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. - `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. - `create_time` — Denotes the time of the space creation. When `useAdminAccess` is `false`, only `create_time` and `relevance` are supported for ordering. Only `DESC` is supported for these fields in non-admin searches. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are when `useAdminAccess` is set to `true`: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC` When `useAdminAccess` is set to `false`: - `create_time DESC` - `relevance DESC` [Developer Preview](https://developers.google.com/workspace/preview).","schema":{"description":"Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. - `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. - `create_time` — Denotes the time of the space creation. When `useAdminAccess` is `false`, only `create_time` and `relevance` are supported for ordering. Only `DESC` is supported for these fields in non-admin searches. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are when `useAdminAccess` is set to `true`: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC` When `useAdminAccess` is set to `false`: - `create_time DESC` - `relevance DESC` [Developer Preview](https://developers.google.com/workspace/preview).","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000 when `useAdminAccess` is set to `true`. Otherwise, the maximum value is 100. If you use a value more than the maximum value, it's automatically changed to the maximum value.","schema":{"description":"The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000 when `useAdminAccess` is set to `true`. Otherwise, the maximum value is 100. If you use a value more than the maximum value, it's automatically changed to the maximum value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:\"Hello World\" AND space_type = \"SPACE\" (display_name:\"Hello\" OR display_name:\"Fun\") AND space_type = \"SPACE\" (external_user_allowed = \"true\" AND space_type = \"SPACE\") // Returns an empty response. (external_user_allowed = \"true\" AND display_name:\"Hello\" AND space_type = \"SPACE\") ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:\"Hello World\" AND space_type = \"SPACE\" (display_name:\"Hello\" OR display_name:\"Fun\") AND space_type = \"SPACE\" (external_user_allowed = \"true\" AND space_type = \"SPACE\") // Returns an empty response. (external_user_allowed = \"true\" AND display_name:\"Hello\" AND space_type = \"SPACE\") ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SearchSpacesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces:setup":{"post":{"operationId":"chat.spaces.setup","x-executor-toolPath":"chat.spaces.setup","tags":["Google Chat API"],"description":"Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SetUpSpaceRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/users/{usersId}/availability":{"get":{"operationId":"chat.users.availability.get","x-executor-toolPath":"chat.users.availability.get","tags":["Google Chat API"],"description":"Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/availability`). Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"`usersId` of `name` (`users/{usersId}/availability`). Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]},"patch":{"operationId":"chat.users.availability.patch","x-executor-toolPath":"chat.users.availability.patch","tags":["Google Chat API"],"description":"Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/availability`). Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"`usersId` of `name` (`users/{usersId}/availability`). Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The list of fields to update. The only field that can be updated is `custom_status`.","schema":{"description":"Required. The list of fields to update. The only field that can be updated is `custom_status`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/users/{usersId}/sections/{sectionsId}":{"delete":{"operationId":"chat.users.sections.delete","x-executor-toolPath":"chat.users.sections.delete","tags":["Google Chat API"],"description":"Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","schema":{"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"sectionsId","in":"path","required":true,"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","schema":{"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]},"patch":{"operationId":"chat.users.sections.patch","x-executor-toolPath":"chat.users.sections.patch","tags":["Google Chat API"],"description":"Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","schema":{"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"sectionsId","in":"path","required":true,"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","schema":{"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The mask to specify which fields to update. Currently supported field paths: - `display_name`","schema":{"description":"Required. The mask to specify which fields to update. Currently supported field paths: - `display_name`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting":{"get":{"operationId":"chat.users.spaces.spaceNotificationSetting.get","x-executor-toolPath":"chat.users.spaces.spaceNotificationSetting.get","tags":["Google Chat API"],"description":"Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceNotificationSetting"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.spacesettings"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.spacesettings"]},"patch":{"operationId":"chat.users.spaces.spaceNotificationSetting.patch","x-executor-toolPath":"chat.users.spaces.spaceNotificationSetting.patch","tags":["Google Chat API"],"description":"Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Supported field paths: - `notification_setting` - `mute_setting`","schema":{"description":"Required. Supported field paths: - `notification_setting` - `mute_setting`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceNotificationSetting"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceNotificationSetting"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.spacesettings"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.spacesettings"]}},"/v1/users/{usersId}/spaces/{spacesId}/spaceReadState":{"get":{"operationId":"chat.users.spaces.getSpaceReadState","x-executor-toolPath":"chat.users.spaces.getSpaceReadState","tags":["Google Chat API"],"description":"Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceReadState"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.readstate"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.readstate"]},"patch":{"operationId":"chat.users.spaces.updateSpaceReadState","x-executor-toolPath":"chat.users.spaces.updateSpaceReadState","tags":["Google Chat API"],"description":"Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set `last_read_time` to any value later (larger) than the latest message create time. The `last_read_time` is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.","schema":{"description":"Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set `last_read_time` to any value later (larger) than the latest message create time. The `last_read_time` is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceReadState"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceReadState"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.readstate"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.readstate"]}},"/v1/users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState":{"get":{"operationId":"chat.users.spaces.threads.getThreadReadState","x-executor-toolPath":"chat.users.spaces.threads.getThreadReadState","tags":["Google Chat API"],"description":"Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","type":"string"},"allowReserved":true},{"name":"threadsId","in":"path","required":true,"description":"`threadsId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","schema":{"description":"`threadsId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ThreadReadState"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.readstate"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.readstate"]}},"/v1/{name}":{"put":{"operationId":"chat.spaces.messages.update","x-executor-toolPath":"chat.spaces.messages.update","tags":["Google Chat API"],"description":"Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.","parameters":[{"name":"name","in":"path","required":true,"description":"Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allowMissing","in":"query","required":false,"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","schema":{"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","schema":{"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{name}:markAsActive":{"post":{"operationId":"chat.users.availability.markAsActive","x-executor-toolPath":"chat.users.availability.markAsActive","tags":["Google Chat API"],"description":"Marks user as `ACTIVE` in Google Chat. Sets the user's availability state to `ACTIVE`. The `ACTIVE` state lasts until the specified expiration, at which point the user's state becomes `AWAY`. Note that if the user is actively using Chat, the `ACTIVE` state duration may extend beyond the provided expiration. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the availability to mark as active. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"Required. The resource name of the availability to mark as active. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MarkAsActiveRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/{name}:markAsAway":{"post":{"operationId":"chat.users.availability.markAsAway","x-executor-toolPath":"chat.users.availability.markAsAway","tags":["Google Chat API"],"description":"Marks user as `AWAY` in Google Chat. Sets the user's state to away and is not affected by the user's activity. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MarkAsAwayRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/{name}:markAsDoNotDisturb":{"post":{"operationId":"chat.users.availability.markAsDoNotDisturb","x-executor-toolPath":"chat.users.availability.markAsDoNotDisturb","tags":["Google Chat API"],"description":"Marks user as `DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MarkAsDoNotDisturbRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/{name}:move":{"post":{"operationId":"chat.users.sections.items.move","x-executor-toolPath":"chat.users.sections.items.move","tags":["Google Chat API"],"description":"Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}`","schema":{"description":"Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MoveSectionItemRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MoveSectionItemResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{name}:position":{"post":{"operationId":"chat.users.sections.position","x-executor-toolPath":"chat.users.sections.position","tags":["Google Chat API"],"description":"Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`","schema":{"description":"Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_PositionSectionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_PositionSectionResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{parent}/attachments:upload":{"post":{"operationId":"chat.media.upload","x-executor-toolPath":"chat.media.upload","tags":["Google Chat API"],"description":"Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","schema":{"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_UploadAttachmentRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_UploadAttachmentResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/items":{"get":{"operationId":"chat.users.sections.items.list","x-executor-toolPath":"chat.users.sections.items.list","tags":["Google Chat API"],"description":"Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`","schema":{"description":"Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSectionItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{parent}/members":{"get":{"operationId":"chat.spaces.members.list","x-executor-toolPath":"chat.spaces.members.list","tags":["Google Chat API"],"description":"Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}","schema":{"description":"Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showGroups","in":"query","required":false,"description":"Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.","schema":{"description":"Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.","type":"boolean"},"style":"form","explode":false},{"name":"showInvited","in":"query","required":false,"description":"Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","schema":{"description":"Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListMembershipsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]},"post":{"operationId":"chat.spaces.members.create","x-executor-toolPath":"chat.spaces.members.create","tags":["Google Chat API"],"description":"Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to add the calling app to the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Inviting users external to the Workspace organization that owns the space. - Adding a Google Group to a space. - Adding a Chat app to a space. For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space for which to create the membership. Format: spaces/{space}","schema":{"description":"Required. The resource name of the space for which to create the membership. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]}},"/v1/{parent}/messagePins":{"get":{"operationId":"chat.spaces.messagePins.list","x-executor-toolPath":"chat.spaces.messagePins.list","tags":["Google Chat API"],"description":"Lists message pins in a space. Users can pin important messages in spaces for easy access. For more information, see [Pin or unpin a conversation in Google Chat](https://support.google.com/chat/answer/15622437). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins.readonly` - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent space which owns the collection of pinned items Format: `spaces/{space}`","schema":{"description":"Required. The parent space which owns the collection of pinned items Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token received from a previous list message pins call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token received from a previous list message pins call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListMessagePinsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]},"post":{"operationId":"chat.spaces.messagePins.create","x-executor-toolPath":"chat.spaces.messagePins.create","tags":["Google Chat API"],"description":"Creates a message pin. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent space in which to create the message pin. Format: spaces/{space}","schema":{"description":"Required. The parent space in which to create the message pin. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MessagePin"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MessagePin"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/{parent}/messages":{"get":{"operationId":"chat.spaces.messages.list","x-executor-toolPath":"chat.spaces.messages.list","tags":["Google Chat API"],"description":"Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space to list messages from. Format: `spaces/{space}`","schema":{"description":"Required. The resource name of the space to list messages from. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > \"2012-04-21T11:30:00-04:00\" create_time > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > \"2012-04-21T11:30:00+00:00\" AND create_time < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > \"2012-04-21T11:30:00-04:00\" create_time > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > \"2012-04-21T11:30:00+00:00\" AND create_time < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"markupSyntax","in":"query","required":false,"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","schema":{"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.","schema":{"description":"Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.","schema":{"description":"Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListMessagesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]},"post":{"operationId":"chat.spaces.messages.create","x-executor-toolPath":"chat.spaces.messages.create","tags":["Google Chat API"],"description":"Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space in which to create a message. Format: `spaces/{space}`","schema":{"description":"Required. The resource name of the space in which to create a message. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"createMessageNotificationOptions.notificationType","in":"query","required":false,"description":"The notification type for the message.","schema":{"description":"The notification type for the message.","enum":["NOTIFICATION_TYPE_NONE","NOTIFICATION_TYPE_FORCE_NOTIFY","NOTIFICATION_TYPE_SILENT"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"messageId","in":"query","required":false,"description":"Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"style":"form","explode":false},{"name":"messageReplyOption","in":"query","required":false,"description":"Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.","schema":{"description":"Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.","enum":["MESSAGE_REPLY_OPTION_UNSPECIFIED","REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD","REPLY_MESSAGE_OR_FAIL"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":false,"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call `GetMessage`. - Reusing an existing request ID with a different authenticated user results in an error.","schema":{"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call `GetMessage`. - Reusing an existing request ID with a different authenticated user results in an error.","type":"string"},"style":"form","explode":false},{"name":"threadKey","in":"query","required":false,"description":"Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).","schema":{"description":"Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/messages:search":{"post":{"operationId":"chat.spaces.messages.search","x-executor-toolPath":"chat.spaces.messages.search","tags":["Google Chat API"],"description":"Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set `parent` to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. The returned messages have their `name` field populated with the full resource name, which includes the specific `space` in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Messages that are visible to the authenticated user. - Messages posted by Chat apps in spaces or group chats. - Messages in a Chat app DM. - Messages from blocked users. - Messages in spaces that the caller has muted. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.","schema":{"description":"Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SearchMessagesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SearchMessagesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/reactions":{"get":{"operationId":"chat.spaces.messages.reactions.list","x-executor-toolPath":"chat.spaces.messages.reactions.list","tags":["Google Chat API"],"description":"Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`","schema":{"description":"Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"🙂\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"🙂\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" AND user.name = \"users/{user}\" (emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"🙂\" AND emoji.unicode = \"👍\" emoji.unicode = \"🙂\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"🙂\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"🙂\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" AND user.name = \"users/{user}\" (emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"🙂\" AND emoji.unicode = \"👍\" emoji.unicode = \"🙂\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","schema":{"description":"Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","schema":{"description":"Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListReactionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]},"post":{"operationId":"chat.spaces.messages.reactions.create","x-executor-toolPath":"chat.spaces.messages.reactions.create","tags":["Google Chat API"],"description":"Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.create` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`","schema":{"description":"Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Reaction"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Reaction"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/sections":{"get":{"operationId":"chat.users.sections.list","x-executor-toolPath":"chat.users.sections.list","tags":["Google Chat API"],"description":"Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}`","schema":{"description":"Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSectionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]},"post":{"operationId":"chat.users.sections.create","x-executor-toolPath":"chat.users.sections.create","tags":["Google Chat API"],"description":"Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent resource name where the section is created. Format: `users/{user}`","schema":{"description":"Required. The parent resource name where the section is created. Format: `users/{user}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{parent}/spaceEvents":{"get":{"operationId":"chat.spaces.spaceEvents.list","x-executor-toolPath":"chat.spaces.spaceEvents.list","tags":["Google Chat API"],"description":"Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.","schema":{"description":"Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSpaceEventsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces","https://www.googleapis.com/auth/chat.memberships","https://www.googleapis.com/auth/chat.messages"]}}},"components":{"schemas":{"chat_v1_AccessPermissionSetting":{"description":"An access permission setting.","type":"object","properties":{"principals":{"description":"Optional. Unordered list. Allowed principals for this permission.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Principal"}}}},"chat_v1_AccessPermissionSettings":{"description":"Access permission settings for a space.","type":"object","properties":{"discoverSpaceSetting":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSetting"},"joinSpaceSetting":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSetting"},"viewSpaceMembershipSetting":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSetting"}}},"chat_v1_AccessSettings":{"description":"Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space.","type":"object","properties":{"accessPermissionSettings":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSettings"},"accessState":{"description":"Output only. Indicates the access state of the space.","readOnly":true,"enum":["ACCESS_STATE_UNSPECIFIED","PRIVATE","DISCOVERABLE"],"type":"string"},"audience":{"description":"Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","type":"string"}}},"chat_v1_AccessoryWidget":{"description":"One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"}}},"chat_v1_ActionParameter":{"description":"List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.","type":"object","properties":{"key":{"description":"The name of the parameter for the action script.","type":"string"},"value":{"description":"The value of the parameter.","type":"string"}}},"chat_v1_ActionResponse":{"description":"Parameters that a Chat app can use to configure how its response is posted.","type":"object","properties":{"dialogAction":{"$ref":"#/components/schemas/chat_v1_DialogAction"},"type":{"description":"Input only. The type of Chat app response.","enum":["TYPE_UNSPECIFIED","NEW_MESSAGE","UPDATE_MESSAGE","UPDATE_USER_MESSAGE_CARDS","REQUEST_CONFIG","DIALOG","UPDATE_WIDGET"],"type":"string"},"updatedWidget":{"$ref":"#/components/schemas/chat_v1_UpdatedWidget"},"url":{"description":"Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)","type":"string"}}},"chat_v1_ActionStatus":{"description":"Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs).","type":"object","properties":{"statusCode":{"description":"The status code.","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"type":"string"},"userFacingMessage":{"description":"The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent.","type":"string"}}},"chat_v1_Annotation":{"description":"Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```","type":"object","properties":{"customEmojiMetadata":{"$ref":"#/components/schemas/chat_v1_CustomEmojiMetadata"},"length":{"description":"Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.","format":"int32","type":"integer"},"richLinkMetadata":{"$ref":"#/components/schemas/chat_v1_RichLinkMetadata"},"slashCommand":{"$ref":"#/components/schemas/chat_v1_SlashCommandMetadata"},"startIndex":{"description":"Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.","format":"int32","type":"integer"},"type":{"description":"The type of this annotation.","enum":["ANNOTATION_TYPE_UNSPECIFIED","USER_MENTION","SLASH_COMMAND","RICH_LINK","CUSTOM_EMOJI"],"type":"string"},"userMention":{"$ref":"#/components/schemas/chat_v1_UserMentionMetadata"}}},"chat_v1_AppCommandMetadata":{"description":"Metadata about a [Chat app command](https://developers.google.com/workspace/chat/commands).","type":"object","properties":{"appCommandId":{"description":"The ID for the command specified in the Chat API configuration.","format":"int32","type":"integer"},"appCommandType":{"description":"The type of Chat app command.","enum":["APP_COMMAND_TYPE_UNSPECIFIED","SLASH_COMMAND","QUICK_COMMAND","MESSAGE_ACTION"],"type":"string"}}},"chat_v1_AttachedGif":{"description":"A GIF image that's specified by a URL.","type":"object","properties":{"uri":{"description":"Output only. The URL that hosts the GIF image.","readOnly":true,"type":"string"}}},"chat_v1_Attachment":{"description":"An attachment in Google Chat.","type":"object","properties":{"attachmentDataRef":{"$ref":"#/components/schemas/chat_v1_AttachmentDataRef"},"contentName":{"description":"Output only. The original file name for the content, not the full path.","readOnly":true,"type":"string"},"contentType":{"description":"Output only. The content type (MIME type) of the file.","readOnly":true,"type":"string"},"downloadUri":{"description":"Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content.","readOnly":true,"type":"string"},"driveDataRef":{"$ref":"#/components/schemas/chat_v1_DriveDataRef"},"name":{"description":"Identifier. Resource name of the attachment. Format: `spaces/{space}/messages/{message}/attachments/{attachment}`.","type":"string"},"source":{"description":"Output only. The source of the attachment.","readOnly":true,"enum":["SOURCE_UNSPECIFIED","DRIVE_FILE","UPLOADED_CONTENT"],"type":"string"},"thumbnailUri":{"description":"Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.","readOnly":true,"type":"string"}}},"chat_v1_AttachmentDataRef":{"description":"A reference to the attachment data.","type":"object","properties":{"attachmentUploadToken":{"description":"Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.","type":"string"},"resourceName":{"description":"Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.","type":"string"}}},"chat_v1_Audience":{"description":"A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience).","type":"object","properties":{"name":{"description":"The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.","type":"string"}}},"chat_v1_Availability":{"description":"Represents a user's current availability information in Google Chat, including their state (for example, Active, Away, Do Not Disturb) and any custom status.","type":"object","properties":{"customStatus":{"$ref":"#/components/schemas/chat_v1_CustomStatus"},"doNotDisturbMetadata":{"$ref":"#/components/schemas/chat_v1_DoNotDisturbMetadata"},"name":{"description":"Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"state":{"description":"Output only. The user's current availability state.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","IDLE","AWAY","DO_NOT_DISTURB"],"type":"string"}}},"chat_v1_Button":{"description":"A button. Can be a text button or an image button.","type":"object","properties":{"imageButton":{"$ref":"#/components/schemas/chat_v1_ImageButton"},"textButton":{"$ref":"#/components/schemas/chat_v1_TextButton"}}},"chat_v1_CalendarEventLinkData":{"description":"Data for Calendar event links.","type":"object","properties":{"calendarId":{"description":"The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.","type":"string"},"eventId":{"description":"The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.","type":"string"}}},"chat_v1_Card":{"description":"A card is a UI element that can contain UI widgets such as text and images.","type":"object","properties":{"cardActions":{"description":"The actions of this card.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_CardAction"}},"header":{"$ref":"#/components/schemas/chat_v1_CardHeader"},"name":{"description":"Name of the card.","type":"string"},"sections":{"description":"Sections are separated by a line divider.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Section"}}}},"chat_v1_CardAction":{"description":"A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser. Not supported by Google Chat apps.","type":"object","properties":{"actionLabel":{"description":"The label used to be displayed in the action menu item.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"}}},"chat_v1_CardHeader":{"type":"object","properties":{"imageStyle":{"description":"The image's type (for example, square border or circular border).","enum":["IMAGE_STYLE_UNSPECIFIED","IMAGE","AVATAR"],"type":"string"},"imageUrl":{"description":"The URL of the image in the card header.","type":"string"},"subtitle":{"description":"The subtitle of the card header.","type":"string"},"title":{"description":"The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines.","type":"string"}}},"chat_v1_CardWithId":{"description":"A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)","type":"object","properties":{"card":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Card"},"cardId":{"description":"Required if the message contains multiple cards. A unique identifier for a card in a message.","type":"string"}}},"chat_v1_ChatAppLogEntry":{"description":"JSON payload of error messages. If the Cloud Logging API is enabled, these error messages are logged to [Google Cloud Logging](https://cloud.google.com/logging/docs).","type":"object","properties":{"deployment":{"description":"The deployment that caused the error. For Chat apps built in Apps Script, this is the deployment ID defined by Apps Script.","type":"string"},"deploymentFunction":{"description":"The unencrypted `callback_method` name that was running when the error was encountered.","type":"string"},"error":{"$ref":"#/components/schemas/chat_v1_Status"}}},"chat_v1_ChatClientDataSourceMarkup":{"description":"For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"spaceDataSource":{"$ref":"#/components/schemas/chat_v1_SpaceDataSource"}}},"chat_v1_ChatSpaceLinkData":{"description":"Data for Chat space links.","type":"object","properties":{"message":{"description":"The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`","type":"string"},"space":{"description":"The space of the linked Chat space resource. Format: `spaces/{space}`","type":"string"},"thread":{"description":"The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`","type":"string"}}},"chat_v1_Color":{"description":"Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...","type":"object","properties":{"alpha":{"description":"The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).","format":"float","type":"number"},"blue":{"description":"The amount of blue in the color as a value in the interval [0, 1].","format":"float","type":"number"},"green":{"description":"The amount of green in the color as a value in the interval [0, 1].","format":"float","type":"number"},"red":{"description":"The amount of red in the color as a value in the interval [0, 1].","format":"float","type":"number"}}},"chat_v1_CommonEventObject":{"description":"The common event object is the portion of the overall event object that carries general, host-independent information to the add-on from the user's client. This information includes details such as the user's locale, host app, and platform. In addition to homepage and contextual triggers, add-ons construct and pass event objects to [action callback functions](https://developers.google.com/workspace/add-ons/concepts/actions#callback_functions) when the user interacts with widgets. Your add-on's callback function can query the common event object to determine the contents of open widgets in the user's client. For example, your add-on can locate the text a user has entered into a [TextInput](https://developers.google.com/apps-script/reference/card-service/text-input) widget in the `eventObject.commentEventObject.formInputs` object. For Chat apps, the name of the function that the user invoked when interacting with a widget.","type":"object","properties":{"formInputs":{"description":"A map containing the current values of the widgets in the displayed card. The map keys are the string IDs assigned with each widget. The structure of the map value object is dependent on the widget type: **Note**: The following examples are formatted for Apps Script's V8 runtime. If you're using Rhino runtime, you must add `[\"\"]` after the value. For example, instead of `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`, format the event object as `e.commonEventObject.formInputs.employeeName[\"\"].stringInputs.value[0]`. To learn more about runtimes in Apps Script, see the [V8 Runtime Overview](https://developers.google.com/apps-script/guides/v8-runtime). * Single-valued widgets (for example, a text box): a list of strings (only one element). **Example**: for a text input widget with `employeeName` as its ID, access the text input value with: `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`. * Multi-valued widgets (for example, checkbox groups): a list of strings. **Example**: for a multi-value widget with `participants` as its ID, access the value array with: `e.commonEventObject.formInputs.participants.stringInputs.value`. * **A date-time picker**: a [`DateTimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input). **Example**: For a picker with an ID of `myDTPicker`, access the [`DateTimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input) object using `e.commonEventObject.formInputs.myDTPicker.dateTimeInput`. * **A date-only picker**: a [`DateInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input). **Example**: For a picker with an ID of `myDatePicker`, access the [`DateInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input) object using `e.commonEventObject.formInputs.myDatePicker.dateInput`. * **A time-only picker**: a [`TimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input). **Example**: For a picker with an ID of `myTimePicker`, access the [`TimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input) object using `e.commonEventObject.formInputs.myTimePicker.timeInput`.","type":"object","additionalProperties":{"$ref":"#/components/schemas/chat_v1_Inputs"}},"hostApp":{"description":"Indicates the host app the add-on is active in when the event object is generated. Possible values include the following: * `GMAIL` * `CALENDAR` * `DRIVE` * `DOCS` * `SHEETS` * `SLIDES` * `CHAT`","enum":["UNSPECIFIED_HOST_APP","GMAIL","CALENDAR","DRIVE","DEMO","DOCS","MEET","SHEETS","SLIDES","DRAWINGS","CHAT"],"type":"string"},"invokedFunction":{"description":"Name of the function to invoke. This field doesn't populate for Google Workspace Add-ons that extend Google Chat. Instead, to receive function data like identifiers, add-ons that extend Chat should use the `parameters` field. See [Build interactive interfaces for Chat apps](https://developers.google.com/workspace/add-ons/chat/build).","type":"string"},"parameters":{"description":"Any additional parameters you supply to an action using [`actionParameters`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#google.apps.card.v1.Action.ActionParameter) or [`Action.setParameters()`](https://developers.google.com/apps-script/reference/card-service/action#setparametersparameters). **Developer Preview:** For [add-ons that extend Google Chat](https://developers.google.com/workspace/add-ons/chat), to suggest items based on what the users type in multiselect menus, use the value of the `\"autocomplete_widget_query\"` key (`event.commonEventObject.parameters[\"autocomplete_widget_query\"]`). You can use this value to query a database and suggest selectable items to users as they type. For details, see [Collect and process information from Google Chat users](https://developers.google.com/workspace/add-ons/chat/collect-information).","type":"object","additionalProperties":{"type":"string"}},"platform":{"description":"The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.","enum":["UNKNOWN_PLATFORM","WEB","IOS","ANDROID"],"type":"string"},"timeZone":{"$ref":"#/components/schemas/chat_v1_TimeZone"},"userLocale":{"description":"**Disabled by default.** The user's language and country/region identifier in the format of [ISO 639](https://wikipedia.org/wiki/ISO_639_macrolanguage) language code-[ISO 3166](https://wikipedia.org/wiki/ISO_3166) country/region code. For example, `en-US`. To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details.","type":"string"}}},"chat_v1_CompleteImportSpaceRequest":{"description":"Request message for completing the import process for a space.","type":"object"},"chat_v1_CompleteImportSpaceResponse":{"description":"Response message for completing the import process for a space.","type":"object","properties":{"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_CustomEmoji":{"description":"Represents a [custom emoji](https://support.google.com/chat/answer/12800149).","type":"object","properties":{"emojiName":{"description":"Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`","type":"string"},"name":{"description":"Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`","type":"string"},"payload":{"$ref":"#/components/schemas/chat_v1_CustomEmojiPayload"},"temporaryImageUri":{"description":"Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.","readOnly":true,"type":"string"},"uid":{"description":"Output only. Unique key for the custom emoji resource.","readOnly":true,"type":"string"}}},"chat_v1_CustomEmojiMetadata":{"description":"Annotation metadata for custom emoji.","type":"object","properties":{"customEmoji":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}},"chat_v1_CustomEmojiPayload":{"description":"Payload data for the custom emoji.","type":"object","properties":{"fileContent":{"description":"Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.","format":"byte","type":"string"},"filename":{"description":"Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`.","type":"string"}}},"chat_v1_CustomStatus":{"description":"Represents a user's custom status in Google Chat. This includes a short text message with an optional emoji that a user sets to give more context about their availability.","type":"object","properties":{"emoji":{"$ref":"#/components/schemas/chat_v1_Emoji"},"expireTime":{"description":"The timestamp when the custom status expires.","format":"google-datetime","type":"string"},"text":{"description":"Required. The text of the custom status. This will be a string with maximum length of 64.","type":"string"},"ttl":{"description":"Input only. The time-to-live duration after which the custom status expires.","format":"google-duration","type":"string"}}},"chat_v1_DateInput":{"description":"Date input values.","type":"object","properties":{"msSinceEpoch":{"description":"Time since epoch time, in milliseconds.","format":"int64","type":"string"}}},"chat_v1_DateTimeInput":{"description":"Date and time input values.","type":"object","properties":{"hasDate":{"description":"Whether the `datetime` input includes a calendar date.","type":"boolean"},"hasTime":{"description":"Whether the `datetime` input includes a timestamp.","type":"boolean"},"msSinceEpoch":{"description":"Time since epoch time, in milliseconds.","format":"int64","type":"string"}}},"chat_v1_DeletionMetadata":{"description":"Information about a deleted message. A message is deleted when `delete_time` is set.","type":"object","properties":{"deletionType":{"description":"Indicates who deleted the message.","enum":["DELETION_TYPE_UNSPECIFIED","CREATOR","SPACE_OWNER","ADMIN","APP_MESSAGE_EXPIRY","CREATOR_VIA_APP","SPACE_OWNER_VIA_APP","SPACE_MEMBER"],"type":"string"}}},"chat_v1_DeprecatedEvent":{"description":" A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). Note: This event is only used for [Chat interaction events](https://developers.google.com/workspace/chat/receive-respond-interactions). If your Chat app is built as a [Google Workspace add-on](https://developers.google.com/workspace/add-ons/chat/build), see [Chat event objects](https://developers.google.com/workspace/add-ons/concepts/event-objects#chat-event-object) in the add-ons documentation.","type":"object","properties":{"action":{"$ref":"#/components/schemas/chat_v1_FormAction"},"appCommandMetadata":{"$ref":"#/components/schemas/chat_v1_AppCommandMetadata"},"common":{"$ref":"#/components/schemas/chat_v1_CommonEventObject"},"configCompleteRedirectUrl":{"description":"This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).","type":"string"},"dialogEventType":{"description":"The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.","enum":["TYPE_UNSPECIFIED","REQUEST_DIALOG","SUBMIT_DIALOG","CANCEL_DIALOG"],"type":"string"},"eventTime":{"description":"The timestamp indicating when the interaction event occurred.","format":"google-datetime","type":"string"},"isDialogEvent":{"description":"For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs).","type":"boolean"},"message":{"$ref":"#/components/schemas/chat_v1_Message"},"space":{"$ref":"#/components/schemas/chat_v1_Space"},"thread":{"$ref":"#/components/schemas/chat_v1_Thread"},"threadKey":{"description":"The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.","type":"string"},"token":{"description":"A secret value that legacy Chat apps can use to verify if a request is from Google. Google randomly generates the token, and its value remains static. You can obtain, revoke, or regenerate the token from the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat) in the Google Cloud Console. Modern Chat apps don't use this field. It is absent from API responses and the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).","type":"string"},"type":{"description":"The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.","enum":["UNSPECIFIED","MESSAGE","ADDED_TO_SPACE","REMOVED_FROM_SPACE","CARD_CLICKED","WIDGET_UPDATED","APP_COMMAND"],"type":"string"},"user":{"$ref":"#/components/schemas/chat_v1_User"}}},"chat_v1_Dialog":{"description":"Wrapper around the card body of the dialog.","type":"object","properties":{"body":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Card"}}},"chat_v1_DialogAction":{"description":"Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and request status code.","type":"object","properties":{"actionStatus":{"$ref":"#/components/schemas/chat_v1_ActionStatus"},"dialog":{"$ref":"#/components/schemas/chat_v1_Dialog"}}},"chat_v1_DoNotDisturbMetadata":{"description":"Metadata associated with the `DO_NOT_DISTURB` availability state, specifying when the state is set to expire.","type":"object","properties":{"expirationTime":{"description":"Output only. Timestamp until which the user should be marked as DO_NOT_DISTURB. This can be maximum of 1 year in the future.","format":"google-datetime","readOnly":true,"type":"string"}}},"chat_v1_DriveDataRef":{"description":"A reference to the data of a drive attachment.","type":"object","properties":{"driveFileId":{"description":"The ID for the drive file. Use with the Drive API.","type":"string"}}},"chat_v1_DriveLinkData":{"description":"Data for Google Drive links.","type":"object","properties":{"driveDataRef":{"$ref":"#/components/schemas/chat_v1_DriveDataRef"},"mimeType":{"description":"The mime type of the linked Google Drive resource.","type":"string"}}},"chat_v1_Emoji":{"description":"An emoji that is used as a reaction to a message.","type":"object","properties":{"customEmoji":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"},"unicode":{"description":"Optional. A basic emoji represented by a unicode string.","type":"string"}}},"chat_v1_EmojiReactionSummary":{"description":"The number of people who reacted to a message with a specific emoji.","type":"object","properties":{"emoji":{"$ref":"#/components/schemas/chat_v1_Emoji"},"reactionCount":{"description":"Output only. The total number of reactions using the associated emoji.","format":"int32","readOnly":true,"type":"integer"}}},"chat_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"chat_v1_FindGroupChatsResponse":{"description":"A response containing group chat spaces with exactly the calling user and the requested users.","type":"object","properties":{"nextPageToken":{"description":"A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"},"spaces":{"description":"List of spaces in the requested (or first) page.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"chat_v1_FormAction":{"description":"A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.","type":"object","properties":{"actionMethodName":{"description":"The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.","type":"string"},"parameters":{"description":"List of action parameters.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_ActionParameter"}}}},"chat_v1_ForwardedMetadata":{"description":"Metadata about the source space from which a message was forwarded.","type":"object","properties":{"space":{"description":"Output only. The resource name of the source space. Format: spaces/{space}","readOnly":true,"type":"string"},"spaceDisplayName":{"description":"Output only. The display name of the source space or DM at the time of forwarding. For `SPACE`, this is the space name. For `DIRECT_MESSAGE`, this is the other participant's name (e.g., \"User A\"). For `GROUP_CHAT`, this is a generated name based on members' first names, limited to 5 including the creator (e.g., \"User A, User B\").","readOnly":true,"type":"string"}}},"chat_v1_GoogleAppsCardV1Action":{"description":"An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"allWidgetsAreRequired":{"description":"Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"boolean"},"function":{"description":"A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"interaction":{"description":"Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):","enum":["INTERACTION_UNSPECIFIED","OPEN_DIALOG"],"type":"string"},"loadIndicator":{"description":"Specifies the loading indicator that the action displays while making the call to the action.","enum":["SPINNER","NONE"],"type":"string"},"parameters":{"description":"List of action parameters.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ActionParameter"}},"persistValues":{"description":"Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.","type":"boolean"},"requiredWidgets":{"description":"Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"array","items":{"type":"string"}}}},"chat_v1_GoogleAppsCardV1ActionParameter":{"description":"List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"key":{"description":"The name of the parameter for the action script.","type":"string"},"value":{"description":"The value of the parameter.","type":"string"}}},"chat_v1_GoogleAppsCardV1BorderStyle":{"description":"The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"cornerRadius":{"description":"The corner radius for the border.","format":"int32","type":"integer"},"strokeColor":{"$ref":"#/components/schemas/chat_v1_Color"},"type":{"description":"The border type.","enum":["BORDER_TYPE_UNSPECIFIED","NO_BORDER","STROKE"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Button":{"description":"A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat\".","type":"string"},"color":{"$ref":"#/components/schemas/chat_v1_Color"},"disabled":{"description":"If `true`, the button is displayed in an inactive state and doesn't respond to user actions.","type":"boolean"},"icon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"text":{"description":"The text displayed inside the button.","type":"string"},"type":{"description":"Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored.","enum":["TYPE_UNSPECIFIED","OUTLINED","FILLED","FILLED_TONAL","BORDERLESS"],"type":"string"}}},"chat_v1_GoogleAppsCardV1ButtonList":{"description":"A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"buttons":{"description":"An array of buttons.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"}}}},"chat_v1_GoogleAppsCardV1Card":{"description":"A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```","type":"object","properties":{"cardActions":{"description":"The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` \"card_actions\": [ { \"actionLabel\": \"Settings\", \"onClick\": { \"action\": { \"functionName\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"LoadIndicator.SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardAction"}},"displayStyle":{"description":"In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","enum":["DISPLAY_STYLE_UNSPECIFIED","PEEK","REPLACE"],"type":"string"},"expressionData":{"description":"The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ExpressionData"}},"fixedFooter":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardFixedFooter"},"header":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardHeader"},"name":{"description":"Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","type":"string"},"peekCardHeader":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardHeader"},"sectionDividerStyle":{"description":"The divider style between the header, sections and footer.","enum":["DIVIDER_STYLE_UNSPECIFIED","SOLID_DIVIDER","NO_DIVIDER"],"type":"string"},"sections":{"description":"Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Section"}}}},"chat_v1_GoogleAppsCardV1CardAction":{"description":"A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","type":"object","properties":{"actionLabel":{"description":"The label that displays as the action menu item.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"}}},"chat_v1_GoogleAppsCardV1CardFixedFooter":{"description":"A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"primaryButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"secondaryButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"}}},"chat_v1_GoogleAppsCardV1CardHeader":{"description":"Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"imageAltText":{"description":"The alternative text of this image that's used for accessibility.","type":"string"},"imageType":{"description":"The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","enum":["SQUARE","CIRCLE"],"type":"string"},"imageUrl":{"description":"The HTTPS URL of the image in the card header.","type":"string"},"subtitle":{"description":"The subtitle of the card header. If specified, appears on its own line below the `title`.","type":"string"},"title":{"description":"Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.","type":"string"}}},"chat_v1_GoogleAppsCardV1Carousel":{"description":"A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Third text paragraph in carousel\", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"carouselCards":{"description":"A list of cards included in the carousel.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CarouselCard"}}}},"chat_v1_GoogleAppsCardV1CarouselCard":{"description":"A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"footerWidgets":{"description":"A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1NestedWidget"}},"widgets":{"description":"A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1NestedWidget"}}}},"chat_v1_GoogleAppsCardV1Chip":{"description":"A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat\".","type":"string"},"disabled":{"description":"Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.","type":"boolean"},"enabled":{"description":"Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.","type":"boolean"},"icon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"label":{"description":"The text displayed inside the chip.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"}}},"chat_v1_GoogleAppsCardV1ChipList":{"description":"A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"chips":{"description":"An array of chips.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Chip"}},"layout":{"description":"Specified chip list layout.","enum":["LAYOUT_UNSPECIFIED","WRAPPED","HORIZONTAL_SCROLLABLE"],"type":"string"}}},"chat_v1_GoogleAppsCardV1CollapseControl":{"description":"Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"collapseButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"expandButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"horizontalAlignment":{"description":"The horizontal alignment of the expand and collapse button.","enum":["HORIZONTAL_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Column":{"description":"A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)","type":"object","properties":{"horizontalAlignment":{"description":"Specifies whether widgets align to the left, right, or center of a column.","enum":["HORIZONTAL_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"horizontalSizeStyle":{"description":"Specifies how a column fills the width of the card.","enum":["HORIZONTAL_SIZE_STYLE_UNSPECIFIED","FILL_AVAILABLE_SPACE","FILL_MINIMUM_SPACE"],"type":"string"},"verticalAlignment":{"description":"Specifies whether widgets align to the top, bottom, or center of a column.","enum":["VERTICAL_ALIGNMENT_UNSPECIFIED","CENTER","TOP","BOTTOM"],"type":"string"},"widgets":{"description":"An array of widgets included in a column. Widgets appear in the order that they are specified.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Widgets"}}}},"chat_v1_GoogleAppsCardV1Columns":{"description":"The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event.","type":"object","properties":{"columnItems":{"description":"An array of columns. You can include up to 2 columns in a card or dialog.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Column"}}}},"chat_v1_GoogleAppsCardV1CommonWidgetAction":{"description":"Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"updateVisibilityAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1UpdateVisibilityAction"}}},"chat_v1_GoogleAppsCardV1Condition":{"description":"Represents a condition that can be used to trigger an action. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"actionRuleId":{"description":"The unique identifier of the ActionRule.","type":"string"},"expressionDataCondition":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ExpressionDataCondition"}}},"chat_v1_GoogleAppsCardV1DataSourceConfig":{"description":"A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.","type":"object","properties":{"minCharactersTrigger":{"description":"The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).","format":"int32","type":"integer"},"platformDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1PlatformDataSource"},"remoteDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"}}},"chat_v1_GoogleAppsCardV1DateTimePicker":{"description":"Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"hostAppDataSource":{"$ref":"#/components/schemas/chat_v1_HostAppDataSourceMarkup"},"label":{"description":"The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.","type":"string"},"name":{"description":"The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"timezoneOffsetDate":{"description":"The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.","format":"int32","type":"integer"},"type":{"description":"Whether the widget supports inputting a date, a time, or the date and time.","enum":["DATE_AND_TIME","DATE_ONLY","TIME_ONLY"],"type":"string"},"valueMsEpoch":{"description":"The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).","format":"int64","type":"string"}}},"chat_v1_GoogleAppsCardV1DecoratedText":{"description":"A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"bottomLabel":{"description":"The text that appears below `text`. Always wraps.","type":"string"},"bottomLabelText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"button":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"contentText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"endIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"icon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"startIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"startIconVerticalAlignment":{"description":"Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):","enum":["VERTICAL_ALIGNMENT_UNSPECIFIED","TOP","MIDDLE","BOTTOM"],"type":"string"},"switchControl":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SwitchControl"},"text":{"description":"Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"topLabel":{"description":"The text that appears above `text`. Always truncates.","type":"string"},"topLabelText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"wrapText":{"description":"The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.","type":"boolean"}}},"chat_v1_GoogleAppsCardV1Divider":{"description":"Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` \"divider\": {} ```","type":"object"},"chat_v1_GoogleAppsCardV1EventAction":{"description":"Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"actionRuleId":{"description":"The unique identifier of the ActionRule.","type":"string"},"commonWidgetAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CommonWidgetAction"},"postEventTriggers":{"description":"The list of triggers that will be triggered after the EventAction is executed.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Trigger"}}}},"chat_v1_GoogleAppsCardV1ExpressionData":{"description":"Represents the data that is used to evaluate an expression. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"conditions":{"description":"The list of conditions that are determined by the expression evaluation result.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Condition"}},"eventActions":{"description":"The list of actions that the ExpressionData can be used.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1EventAction"}},"expression":{"description":"The uncompiled expression.","type":"string"},"id":{"description":"The unique identifier of the ExpressionData.","type":"string"}}},"chat_v1_GoogleAppsCardV1ExpressionDataCondition":{"description":"Represents a condition that is evaluated using CEL. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"conditionType":{"description":"The type of the condition.","enum":["CONDITION_TYPE_UNSPECIFIED","EXPRESSION_EVALUATION_SUCCESS","EXPRESSION_EVALUATION_FAILURE"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Grid":{"description":"Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```","type":"object","properties":{"borderStyle":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1BorderStyle"},"columnCount":{"description":"The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).","format":"int32","type":"integer"},"items":{"description":"The items to display in the grid.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1GridItem"}},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"title":{"description":"The text that displays in the grid header.","type":"string"}}},"chat_v1_GoogleAppsCardV1GridItem":{"description":"Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"id":{"description":"A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.","type":"string"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ImageComponent"},"layout":{"description":"The layout to use for the grid item.","enum":["GRID_ITEM_LAYOUT_UNSPECIFIED","TEXT_BELOW","TEXT_ABOVE"],"type":"string"},"subtitle":{"description":"The grid item's subtitle.","type":"string"},"title":{"description":"The grid item's title.","type":"string"}}},"chat_v1_GoogleAppsCardV1Icon":{"description":"An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.","type":"string"},"iconUrl":{"description":"Display a custom icon hosted at an HTTPS URL. For example: ``` \"iconUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\" ``` Supported file types include `.png` and `.jpg`.","type":"string"},"imageType":{"description":"The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.","enum":["SQUARE","CIRCLE"],"type":"string"},"knownIcon":{"description":"Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).","type":"string"},"materialIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1MaterialIcon"}}},"chat_v1_GoogleAppsCardV1Image":{"description":"An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The alternative text of this image that's used for accessibility.","type":"string"},"imageUrl":{"description":"The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"}}},"chat_v1_GoogleAppsCardV1ImageComponent":{"description":"Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The accessibility label for the image.","type":"string"},"borderStyle":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1BorderStyle"},"cropStyle":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ImageCropStyle"},"imageUri":{"description":"The image URL.","type":"string"}}},"chat_v1_GoogleAppsCardV1ImageCropStyle":{"description":"Represents the crop style applied to an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```","type":"object","properties":{"aspectRatio":{"description":"The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```","format":"double","type":"number"},"type":{"description":"The crop type.","enum":["IMAGE_CROP_TYPE_UNSPECIFIED","SQUARE","CIRCLE","RECTANGLE_CUSTOM","RECTANGLE_4_3"],"type":"string"}}},"chat_v1_GoogleAppsCardV1MaterialIcon":{"description":"A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { \"name\": \"check_box\", \"fill\": true, \"weight\": 300, \"grade\": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"fill":{"description":"Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.","type":"boolean"},"grade":{"description":"Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.","format":"int32","type":"integer"},"name":{"description":"The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.","type":"string"},"weight":{"description":"The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.","format":"int32","type":"integer"}}},"chat_v1_GoogleAppsCardV1NestedWidget":{"description":"A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Image"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"}}},"chat_v1_GoogleAppsCardV1OnClick":{"description":"Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"action":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"card":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Card"},"openDynamicLinkAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"openLink":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OpenLink"},"overflowMenu":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OverflowMenu"}}},"chat_v1_GoogleAppsCardV1OpenLink":{"description":"Represents an `onClick` event that opens a hyperlink. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"onClose":{"description":"Whether the client forgets about a link after opening it, or observes it until the window closes. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","enum":["NOTHING","RELOAD"],"type":"string"},"openAs":{"description":"How to open a link. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","enum":["FULL_SIZE","OVERLAY"],"type":"string"},"url":{"description":"The URL to open. HTTP URLs are converted to HTTPS.","type":"string"}}},"chat_v1_GoogleAppsCardV1OverflowMenu":{"description":"A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"items":{"description":"Required. The list of menu options.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OverflowMenuItem"}}}},"chat_v1_GoogleAppsCardV1OverflowMenuItem":{"description":"An option that users can invoke in an overflow menu. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"disabled":{"description":"Whether the menu option is disabled. Defaults to false.","type":"boolean"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"startIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"text":{"description":"Required. The text that identifies or describes the item to users.","type":"string"}}},"chat_v1_GoogleAppsCardV1PlatformDataSource":{"description":"For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"commonDataSource":{"description":"A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.","enum":["UNKNOWN","USER"],"type":"string"},"hostAppDataSource":{"$ref":"#/components/schemas/chat_v1_HostAppDataSourceMarkup"}}},"chat_v1_GoogleAppsCardV1Section":{"description":"A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"collapseControl":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CollapseControl"},"collapsible":{"description":"Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.","type":"boolean"},"header":{"description":"Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"id":{"description":"A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"string"},"uncollapsibleWidgetsCount":{"description":"The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.","format":"int32","type":"integer"},"widgets":{"description":"All the widgets in the section. Must contain at least one widget.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Widget"}}}},"chat_v1_GoogleAppsCardV1SelectionInput":{"description":"A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"dataSourceConfigs":{"description":"Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DataSourceConfig"}},"externalDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"hintText":{"description":"Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"string"},"items":{"description":"An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionItem"}},"label":{"description":"The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be \"Urgency\" or \"Select urgency\".","type":"string"},"multiSelectMaxSelectedItems":{"description":"For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.","format":"int32","type":"integer"},"multiSelectMinQueryLength":{"description":"For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.","format":"int32","type":"integer"},"name":{"description":"Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"platformDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1PlatformDataSource"},"type":{"description":"The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.","enum":["CHECK_BOX","RADIO_BUTTON","SWITCH","DROPDOWN","MULTI_SELECT"],"type":"string"}}},"chat_v1_GoogleAppsCardV1SelectionItem":{"description":"An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"bottomText":{"description":"For multiselect menus, a text description or label that's displayed below the item's `text` field.","type":"string"},"selected":{"description":"Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.","type":"boolean"},"startIconUri":{"type":"string"},"text":{"description":"The text that identifies or describes the item to users.","type":"string"},"value":{"description":"The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"}}},"chat_v1_GoogleAppsCardV1SuggestionItem":{"description":"One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"text":{"description":"The value of a suggested input to a text input field. This is equivalent to what users enter themselves.","type":"string"}}},"chat_v1_GoogleAppsCardV1Suggestions":{"description":"Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"items":{"description":"A list of suggestions used for autocomplete recommendations in text input fields.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SuggestionItem"}}}},"chat_v1_GoogleAppsCardV1SwitchControl":{"description":"Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget.","type":"object","properties":{"controlType":{"description":"How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","enum":["SWITCH","CHECKBOX","CHECK_BOX"],"type":"string"},"name":{"description":"The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"selected":{"description":"When `true`, the switch is selected.","type":"boolean"},"value":{"description":"The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"}}},"chat_v1_GoogleAppsCardV1TextInput":{"description":"A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"autoCompleteAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"hintText":{"description":"Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.","type":"string"},"hostAppDataSource":{"$ref":"#/components/schemas/chat_v1_HostAppDataSourceMarkup"},"initialSuggestions":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Suggestions"},"label":{"description":"The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.","type":"string"},"name":{"description":"The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"placeholderText":{"description":"Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"string"},"type":{"description":"How a text input field appears in the user interface. For example, whether the field is single or multi-line.","enum":["SINGLE_LINE","MULTIPLE_LINE"],"type":"string"},"validation":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Validation"},"value":{"description":"The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"}}},"chat_v1_GoogleAppsCardV1TextParagraph":{"description":"A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"maxLines":{"description":"The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.","format":"int32","type":"integer"},"text":{"description":"The text that's shown in the widget.","type":"string"},"textSyntax":{"description":"The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):","enum":["TEXT_SYNTAX_UNSPECIFIED","HTML","MARKDOWN"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Trigger":{"description":"Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"actionRuleId":{"description":"The unique identifier of the ActionRule.","type":"string"}}},"chat_v1_GoogleAppsCardV1UpdateVisibilityAction":{"description":"Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"visibility":{"description":"The new visibility.","enum":["VISIBILITY_UNSPECIFIED","VISIBLE","HIDDEN"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Validation":{"description":"Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"characterLimit":{"description":"Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","format":"int32","type":"integer"},"inputType":{"description":"Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","enum":["INPUT_TYPE_UNSPECIFIED","TEXT","INTEGER","FLOAT","EMAIL","EMOJI_PICKER"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Widget":{"description":"Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types.","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"},"carousel":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Carousel"},"chipList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ChipList"},"columns":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Columns"},"dateTimePicker":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DateTimePicker"},"decoratedText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DecoratedText"},"divider":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Divider"},"eventActions":{"description":"Specifies the event actions that can be performed on the widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1EventAction"}},"grid":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Grid"},"horizontalAlignment":{"description":"Specifies whether widgets align to the left, right, or center of a column.","enum":["HORIZONTAL_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"id":{"description":"A unique ID assigned to the widget that's used to identify the widget to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"string"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Image"},"selectionInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionInput"},"textInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextInput"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"visibility":{"description":"Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","enum":["VISIBILITY_UNSPECIFIED","VISIBLE","HIDDEN"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Widgets":{"description":"The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"},"chipList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ChipList"},"dateTimePicker":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DateTimePicker"},"decoratedText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DecoratedText"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Image"},"selectionInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionInput"},"textInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextInput"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"}}},"chat_v1_GoogleChatV1Section":{"description":"Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`.","type":"object","properties":{"displayName":{"description":"Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`.","type":"string"},"name":{"description":"Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","type":"string"},"sortOrder":{"description":"Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value.","format":"int32","type":"integer"},"type":{"description":"Required. The type of the section.","enum":["SECTION_TYPE_UNSPECIFIED","CUSTOM_SECTION","DEFAULT_DIRECT_MESSAGES","DEFAULT_SPACES","DEFAULT_APPS"],"type":"string"}}},"chat_v1_Group":{"description":"A Google Group in Google Chat.","type":"object","properties":{"name":{"description":"Resource name for a Google Group. Represents a [group](https://cloud.google.com/identity/docs/reference/rest/v1/groups) in Cloud Identity Groups API. Format: groups/{group}","type":"string"}}},"chat_v1_HostAppDataSourceMarkup":{"description":"A data source from a Google Workspace application. The data source populates available items for a widget.","type":"object","properties":{"chatDataSource":{"$ref":"#/components/schemas/chat_v1_ChatClientDataSourceMarkup"},"workflowDataSource":{"$ref":"#/components/schemas/chat_v1_WorkflowDataSourceMarkup"}}},"chat_v1_Image":{"description":"An image that's specified by a URL and can have an `onclick` action.","type":"object","properties":{"aspectRatio":{"description":"The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.","format":"double","type":"number"},"imageUrl":{"description":"The URL of the image.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"}}},"chat_v1_ImageButton":{"description":"An image button with an `onclick` action.","type":"object","properties":{"icon":{"description":"The icon specified by an `enum` that indices to an icon provided by Chat API.","enum":["ICON_UNSPECIFIED","AIRPLANE","BOOKMARK","BUS","CAR","CLOCK","CONFIRMATION_NUMBER_ICON","DOLLAR","DESCRIPTION","EMAIL","EVENT_PERFORMER","EVENT_SEAT","FLIGHT_ARRIVAL","FLIGHT_DEPARTURE","HOTEL","HOTEL_ROOM_TYPE","INVITE","MAP_PIN","MEMBERSHIP","MULTIPLE_PEOPLE","OFFER","PERSON","PHONE","RESTAURANT_ICON","SHOPPING_CART","STAR","STORE","TICKET","TRAIN","VIDEO_CAMERA","VIDEO_PLAY"],"type":"string"},"iconUrl":{"description":"The icon specified by a URL.","type":"string"},"name":{"description":"The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"}}},"chat_v1_Inputs":{"description":"Types of data that users can [input on cards or dialogs](https://developers.google.com/chat/ui/read-form-data). The input type depends on the type of values that the widget accepts.","type":"object","properties":{"dateInput":{"$ref":"#/components/schemas/chat_v1_DateInput"},"dateTimeInput":{"$ref":"#/components/schemas/chat_v1_DateTimeInput"},"stringInputs":{"$ref":"#/components/schemas/chat_v1_StringInputs"},"timeInput":{"$ref":"#/components/schemas/chat_v1_TimeInput"}}},"chat_v1_KeyValue":{"description":"A UI element contains a key (label) and a value (content). This element can also contain some actions such as `onclick` button.","type":"object","properties":{"bottomLabel":{"description":"The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"button":{"$ref":"#/components/schemas/chat_v1_Button"},"content":{"description":"The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"contentMultiline":{"description":"If the content should be multiline.","type":"boolean"},"icon":{"description":"An enum value that's replaced by the Chat API with the corresponding icon image.","enum":["ICON_UNSPECIFIED","AIRPLANE","BOOKMARK","BUS","CAR","CLOCK","CONFIRMATION_NUMBER_ICON","DOLLAR","DESCRIPTION","EMAIL","EVENT_PERFORMER","EVENT_SEAT","FLIGHT_ARRIVAL","FLIGHT_DEPARTURE","HOTEL","HOTEL_ROOM_TYPE","INVITE","MAP_PIN","MEMBERSHIP","MULTIPLE_PEOPLE","OFFER","PERSON","PHONE","RESTAURANT_ICON","SHOPPING_CART","STAR","STORE","TICKET","TRAIN","VIDEO_CAMERA","VIDEO_PLAY"],"type":"string"},"iconUrl":{"description":"The icon specified by a URL.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"},"topLabel":{"description":"The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"}}},"chat_v1_ListCustomEmojisResponse":{"description":"A response to list custom emojis.","type":"object","properties":{"customEmojis":{"description":"Unordered list. List of custom emojis.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}},"nextPageToken":{"description":"A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListMembershipsResponse":{"description":"Response to list memberships of the space.","type":"object","properties":{"memberships":{"description":"Unordered list. List of memberships in the requested (or first) page.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Membership"}},"nextPageToken":{"description":"A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListMessagePinsResponse":{"description":"Response message for listing message pins.","type":"object","properties":{"messagePins":{"description":"The pinned messages from the specified space.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessagePin"}},"nextPageToken":{"description":"You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListMessagesResponse":{"description":"Response message for listing messages.","type":"object","properties":{"messages":{"description":"List of messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Message"}},"nextPageToken":{"description":"You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListReactionsResponse":{"description":"Response to a list reactions request.","type":"object","properties":{"nextPageToken":{"description":"Continuation token to retrieve the next page of results. It's empty for the last page of results.","type":"string"},"reactions":{"description":"List of reactions in the requested (or first) page.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Reaction"}}}},"chat_v1_ListSectionItemsResponse":{"description":"Response message for listing section items.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"sectionItems":{"description":"The section items from the specified section.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SectionItem"}}}},"chat_v1_ListSectionsResponse":{"description":"Response message for listing sections.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"sections":{"description":"The sections from the specified user.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}},"chat_v1_ListSpaceEventsResponse":{"description":"Response message for listing space events.","type":"object","properties":{"nextPageToken":{"description":"Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages.","type":"string"},"spaceEvents":{"description":"Results are returned in chronological order (oldest event first). Note: The `permissionSettings` field is not returned in the Space object for list requests.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SpaceEvent"}}}},"chat_v1_ListSpacesResponse":{"description":"The response for a list spaces request.","type":"object","properties":{"nextPageToken":{"description":"You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"},"spaces":{"description":"List of spaces in the requested (or first) page. Note: The `permissionSettings` field is not returned in the Space object for list requests.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"chat_v1_MarkAsActiveRequest":{"description":"Request message for the `MarkAsActive` method.","type":"object","properties":{"expireTime":{"description":"The absolute timestamp when the ACTIVE state expires.","format":"google-datetime","type":"string"},"ttl":{"description":"The duration from the current time until the ACTIVE state expires. Using a short TTL can effectively reset the user's state to be based on activity after this brief duration.","format":"google-duration","type":"string"}}},"chat_v1_MarkAsAwayRequest":{"description":"Request message for the `MarkAsAway` method.","type":"object"},"chat_v1_MarkAsDoNotDisturbRequest":{"description":"Request message for the `MarkAsDoNotDisturb` method.","type":"object","properties":{"expireTime":{"description":"The absolute timestamp when the DND state expires.","format":"google-datetime","type":"string"},"ttl":{"description":"The duration from the current time until the DND state expires.","format":"google-duration","type":"string"}}},"chat_v1_MatchedUrl":{"description":"A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links).","type":"object","properties":{"url":{"description":"Output only. The URL that was matched.","readOnly":true,"type":"string"}}},"chat_v1_Media":{"description":"Media resource.","type":"object","properties":{"resourceName":{"description":"Name of the media resource.","type":"string"}}},"chat_v1_MeetSpaceLinkData":{"description":"Data for Meet space links.","type":"object","properties":{"huddleStatus":{"description":"Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.","readOnly":true,"enum":["HUDDLE_STATUS_UNSPECIFIED","STARTED","ENDED","MISSED"],"type":"string"},"meetingCode":{"description":"Meeting code of the linked Meet space.","type":"string"},"type":{"description":"Indicates the type of the Meet space.","enum":["TYPE_UNSPECIFIED","MEETING","HUDDLE"],"type":"string"}}},"chat_v1_Membership":{"description":"Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.","type":"object","properties":{"affiliation":{"description":"Output only. A user's relationship to the Workspace organization that owns the space. In spaces owned by consumer accounts, the affiliation of all members is `EXTERNAL`.","readOnly":true,"enum":["AFFILIATION_UNSPECIFIED","INTERNAL","EXTERNAL","MANAGED_EXTERNAL"],"type":"string"},"createTime":{"description":"Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.","format":"google-datetime","type":"string"},"deleteTime":{"description":"Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.","format":"google-datetime","type":"string"},"groupMember":{"$ref":"#/components/schemas/chat_v1_Group"},"member":{"$ref":"#/components/schemas/chat_v1_User"},"name":{"description":"Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","type":"string"},"role":{"description":"Optional. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership`.","enum":["MEMBERSHIP_ROLE_UNSPECIFIED","ROLE_MEMBER","ROLE_MANAGER","ROLE_ASSISTANT_MANAGER"],"type":"string"},"state":{"description":"Output only. State of the membership.","readOnly":true,"enum":["MEMBERSHIP_STATE_UNSPECIFIED","JOINED","INVITED","NOT_A_MEMBER"],"type":"string"}}},"chat_v1_MembershipBatchCreatedEventData":{"description":"Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`","type":"object","properties":{"memberships":{"description":"A list of new memberships.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MembershipCreatedEventData"}}}},"chat_v1_MembershipBatchDeletedEventData":{"description":"Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`","type":"object","properties":{"memberships":{"description":"A list of deleted memberships.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MembershipDeletedEventData"}}}},"chat_v1_MembershipBatchUpdatedEventData":{"description":"Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`","type":"object","properties":{"memberships":{"description":"A list of updated memberships.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MembershipUpdatedEventData"}}}},"chat_v1_MembershipCount":{"description":"Represents the count of memberships of a space, grouped into categories.","type":"object","properties":{"joinedDirectHumanUserCount":{"description":"Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.","format":"int32","readOnly":true,"type":"integer"},"joinedGroupCount":{"description":"Output only. Count of all groups that have directly joined the space.","format":"int32","readOnly":true,"type":"integer"}}},"chat_v1_MembershipCreatedEventData":{"description":"Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`.","type":"object","properties":{"membership":{"$ref":"#/components/schemas/chat_v1_Membership"}}},"chat_v1_MembershipDeletedEventData":{"description":"Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`","type":"object","properties":{"membership":{"$ref":"#/components/schemas/chat_v1_Membership"}}},"chat_v1_MembershipUpdatedEventData":{"description":"Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`","type":"object","properties":{"membership":{"$ref":"#/components/schemas/chat_v1_Membership"}}},"chat_v1_Message":{"description":"A message in a Google Chat space.","type":"object","properties":{"accessoryWidgets":{"description":"Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).","type":"array","items":{"$ref":"#/components/schemas/chat_v1_AccessoryWidget"}},"actionResponse":{"$ref":"#/components/schemas/chat_v1_ActionResponse"},"annotations":{"description":"Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_Annotation"}},"argumentText":{"description":"Output only. Plain-text body of the message with all Chat app mentions stripped out.","readOnly":true,"type":"string"},"attachedGifs":{"description":"Output only. GIF images that are attached to the message.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_AttachedGif"}},"attachment":{"description":"Optional. User-uploaded attachment.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Attachment"}},"cards":{"description":"Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Card"}},"cardsV2":{"description":"Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)","type":"array","items":{"$ref":"#/components/schemas/chat_v1_CardWithId"}},"clientAssignedMessageId":{"description":"Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"createTime":{"description":"Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.","format":"google-datetime","type":"string"},"deleteTime":{"description":"Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.","format":"google-datetime","readOnly":true,"type":"string"},"deletionMetadata":{"$ref":"#/components/schemas/chat_v1_DeletionMetadata"},"emojiReactionSummaries":{"description":"Output only. The list of emoji reaction summaries on the message.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_EmojiReactionSummary"}},"fallbackText":{"description":"Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.","type":"string"},"formattedText":{"description":"Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)","readOnly":true,"type":"string"},"lastUpdateTime":{"description":"Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.","format":"google-datetime","readOnly":true,"type":"string"},"markupSyntax":{"description":"Optional. Specifies how the server interprets the message `text` field content.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"matchedUrl":{"$ref":"#/components/schemas/chat_v1_MatchedUrl"},"name":{"description":"Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"privateMessageViewer":{"$ref":"#/components/schemas/chat_v1_User"},"quotedMessageMetadata":{"$ref":"#/components/schemas/chat_v1_QuotedMessageMetadata"},"sender":{"$ref":"#/components/schemas/chat_v1_User"},"silent":{"description":"Output only. Whether this is a silent message. Silent messages are messages where Chat suppresses push notifications for recipients.","readOnly":true,"type":"boolean"},"slashCommand":{"$ref":"#/components/schemas/chat_v1_SlashCommand"},"space":{"$ref":"#/components/schemas/chat_v1_Space"},"text":{"description":"Optional. Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a message](https://developers.google.com/workspace/chat/create-messages).","type":"string"},"thread":{"$ref":"#/components/schemas/chat_v1_Thread"},"threadReply":{"description":"Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`.","readOnly":true,"type":"boolean"}}},"chat_v1_MessageBatchCreatedEventData":{"description":"Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`","type":"object","properties":{"messages":{"description":"A list of new messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessageCreatedEventData"}}}},"chat_v1_MessageBatchDeletedEventData":{"description":"Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`","type":"object","properties":{"messages":{"description":"A list of deleted messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessageDeletedEventData"}}}},"chat_v1_MessageBatchUpdatedEventData":{"description":"Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`","type":"object","properties":{"messages":{"description":"A list of updated messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessageUpdatedEventData"}}}},"chat_v1_MessageCreatedEventData":{"description":"Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"}}},"chat_v1_MessageDeletedEventData":{"description":"Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"}}},"chat_v1_MessagePin":{"description":"A pin on a Chat message. For more information see [Pin a message](https://support.google.com/chat?p=chat-board-hc).","type":"object","properties":{"message":{"description":"Required. Immutable. The resource name of the message that is pinned. Format: `spaces/{space}/messages/{message}`","type":"string"},"name":{"description":"Identifier. The resource name of the message pin. Format: `spaces/{space}/messagePins/{message_pin}` The resource ID component matches the resource ID component of the message. For example, a message with `spaces/AAA/messages/bbb.ccc` corresponds to the message pin with the resource name `spaces/AAA/messagePins/bbb.ccc`.","type":"string"}}},"chat_v1_MessageUpdatedEventData":{"description":"Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"}}},"chat_v1_MoveSectionItemRequest":{"description":"Request message for moving a section item across sections.","type":"object","properties":{"targetSection":{"description":"Required. The resource name of the section to move the section item to. Format: `users/{user}/sections/{section}`","type":"string"}}},"chat_v1_MoveSectionItemResponse":{"description":"Response message for moving a section item.","type":"object","properties":{"sectionItem":{"$ref":"#/components/schemas/chat_v1_SectionItem"}}},"chat_v1_OnClick":{"description":"An `onclick` action (for example, open a link).","type":"object","properties":{"action":{"$ref":"#/components/schemas/chat_v1_FormAction"},"openLink":{"$ref":"#/components/schemas/chat_v1_OpenLink"}}},"chat_v1_OpenLink":{"description":"A link that opens a new window.","type":"object","properties":{"url":{"description":"The URL to open.","type":"string"}}},"chat_v1_PermissionSetting":{"description":"Represents a space permission setting.","type":"object","properties":{"assistantManagersAllowed":{"description":"Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.","type":"boolean"},"managersAllowed":{"description":"Optional. Whether space owners (`ROLE_MANAGER`) have this permission.","type":"boolean"},"membersAllowed":{"description":"Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.","type":"boolean"}}},"chat_v1_PermissionSettings":{"description":"[Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request.","type":"object","properties":{"manageApps":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"manageMembersAndGroups":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"manageWebhooks":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"modifySpaceDetails":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"postMessages":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"replyMessages":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"toggleHistory":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"useAtMentionAll":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"viewSpaceMembership":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"}}},"chat_v1_PositionSectionRequest":{"description":"Request message for positioning a section.","type":"object","properties":{"relativePosition":{"description":"Optional. The relative position of the section in the list of sections.","enum":["POSITION_UNSPECIFIED","START","END"],"type":"string"},"sortOrder":{"description":"Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.","format":"int32","type":"integer"}}},"chat_v1_PositionSectionResponse":{"description":"Response message for positioning a section.","type":"object","properties":{"section":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}},"chat_v1_Principal":{"description":"A principal representing an entity granted access.","type":"object","properties":{"audience":{"$ref":"#/components/schemas/chat_v1_Audience"}}},"chat_v1_QuotedMessageMetadata":{"description":"Information about a message that another message quotes. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see [Quote another message](https://developers.google.com/workspace/chat/create-messages#quote-a-message).","type":"object","properties":{"forwardedMetadata":{"$ref":"#/components/schemas/chat_v1_ForwardedMetadata"},"lastUpdateTime":{"description":"Required. The timestamp when the quoted message was created or when the quoted message was last updated. If the message was edited, use this field, `last_update_time`. If the message was never edited, use `create_time`. If `last_update_time` doesn't match the latest version of the quoted message, the request fails.","format":"google-datetime","type":"string"},"name":{"description":"Required. Resource name of the message that is quoted. Format: `spaces/{space}/messages/{message}`","type":"string"},"quoteType":{"description":"Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility.","enum":["QUOTE_TYPE_UNSPECIFIED","REPLY","FORWARD"],"type":"string"},"quotedMessageSnapshot":{"$ref":"#/components/schemas/chat_v1_QuotedMessageSnapshot"}}},"chat_v1_QuotedMessageSnapshot":{"description":"Provides a snapshot of the content of the quoted message at the time of quoting or forwarding","type":"object","properties":{"annotations":{"description":"Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_Annotation"}},"attachments":{"description":"Output only. Attachments that were part of the quoted message. These are copies of the quoted message's attachment metadata. Populated only for FORWARD quote type.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_Attachment"}},"formattedText":{"description":"Output only. Contains the quoted message `text` with markups added to support rich formatting like hyperlinks,custom emojis, markup, etc. Populated only for FORWARD quote type.","readOnly":true,"type":"string"},"sender":{"description":"Output only. The quoted message's author name. Populated for both REPLY & FORWARD quote types.","readOnly":true,"type":"string"},"text":{"description":"Output only. Snapshot of the quoted message's text content.","readOnly":true,"type":"string"}}},"chat_v1_Reaction":{"description":"A reaction to a message.","type":"object","properties":{"emoji":{"$ref":"#/components/schemas/chat_v1_Emoji"},"name":{"description":"Identifier. The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"user":{"$ref":"#/components/schemas/chat_v1_User"}}},"chat_v1_ReactionBatchCreatedEventData":{"description":"Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`","type":"object","properties":{"reactions":{"description":"A list of new reactions.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_ReactionCreatedEventData"}}}},"chat_v1_ReactionBatchDeletedEventData":{"description":"Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`","type":"object","properties":{"reactions":{"description":"A list of deleted reactions.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_ReactionDeletedEventData"}}}},"chat_v1_ReactionCreatedEventData":{"description":"Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`","type":"object","properties":{"reaction":{"$ref":"#/components/schemas/chat_v1_Reaction"}}},"chat_v1_ReactionDeletedEventData":{"description":"Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted`","type":"object","properties":{"reaction":{"$ref":"#/components/schemas/chat_v1_Reaction"}}},"chat_v1_RichLinkMetadata":{"description":"A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.","type":"object","properties":{"calendarEventLinkData":{"$ref":"#/components/schemas/chat_v1_CalendarEventLinkData"},"chatSpaceLinkData":{"$ref":"#/components/schemas/chat_v1_ChatSpaceLinkData"},"driveLinkData":{"$ref":"#/components/schemas/chat_v1_DriveLinkData"},"meetSpaceLinkData":{"$ref":"#/components/schemas/chat_v1_MeetSpaceLinkData"},"richLinkType":{"description":"The rich link type.","enum":["RICH_LINK_TYPE_UNSPECIFIED","DRIVE_FILE","CHAT_SPACE","GMAIL_MESSAGE","MEET_SPACE","CALENDAR_EVENT"],"type":"string"},"uri":{"description":"The URI of this link.","type":"string"}}},"chat_v1_SearchMessageResult":{"description":"A single result item from a message search.","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"},"read":{"description":"Indicates if the matched message is read by the calling user. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`","type":"boolean"},"spaceMuteSetting":{"description":"The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include the following [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`","enum":["MUTE_SETTING_UNSPECIFIED","UNMUTED","MUTED"],"type":"string"}}},"chat_v1_SearchMessagesRequest":{"description":"Request message for searching messages.","type":"object","properties":{"filter":{"description":"Required. A search query. The query can specify one or more search keywords, which are used to filter the results, You can also filter the results using the following message fields: - `create_time`: Accepts a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `<` and `>=`. - `sender.name`: The resource name of the sender (`users/{user}`). Only supports `=`. You can use the e-mail as an alias for `{user}`. For example, `users/example@gmail.com`, where `example@gmail.com` is the e-mail of the Google Chat user. - `space.name`: The resource name of the space where the message is posted. (`spaces/{space}`). Only supports `=`. If this filter is not set, the search is performed across all direct messages and spaces the user has access to as a space member. - `space.display_name`: Supports the operator `:` (has) and filters spaces based on a partial match of their display name. Results are limited to the top five space matches. For example, `space.display_name:Project` searches for messages in the top five spaces that contain the word \"Project\" in their display names. - `space.space_type`: The type of the space. Only supports `=`. For example, `space.space_type=\"DIRECT_MESSAGE\"` returns only messages from direct messages. The possible values are `DIRECT_MESSAGE`, `GROUP_CHAT`, and `SPACE`. - `attachment`: Supports the operator `:*` (has any) to check for the presence of attachments. If `attachment:*` is specified, only messages that have at least one attachment are returned. - `annotations.user_mentions.user.name`: The resource name of the mentioned user (`users/{user}`). Only supports `:` (has). For example: `annotations.user_mentions.user.name:\"users/1234567890\"` returns only messages that contain a mention to the specified user. Alternatively, the alias `me` can be used to filter for messages that mention the caller user, for example: `annotations.user_mentions.user.name:users/me`. You can also use the e-mail as an alias for `{user}`, for example, `users/example@gmail.com`. For advanced filtering, the following functions are also available: - `has_link()`: Returns only messages that have at least one hyperlink in the message text. - `is_unread()`: Filters out messages that have been read by the calling user. Using the `space.display_name` or the `space.space_type` filters requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` Using the `is_unread()` filter requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` Across different fields, only `AND` operators are supported. A valid example is `sender.name = \"users/1234567890\" AND is_unread()`. The word `AND` is optional and is implied if omitted. For example, `sender.name = \"users/1234567890\" is_unread()` is valid and is equivalent to the previous example. An invalid example is `sender.name = \"users/1234567890\" OR is_unread()` because `OR` is not supported between different fields. Among the same field: - `create_time` supports only `AND`, and can only be used to represent an interval, such as `create_time >= \"2022-01-01T00:00:00+00:00\" AND create_time < \"2023-01-01T00:00:00+00:00\"`. - `sender.name` supports only the `OR` operator, for example: `sender.name = \"users/1234567890\" OR sender.name = \"users/0987654321\"`. - `space.name` supports only the `OR` operator, for example: `space.name = \"spaces/ABCDEFGH\" OR space.name = \"spaces/QWERTYUI\"`. - `space.display_name` supports the operators `AND` and `OR`, but not a mix of both. For example: `space.display_name:Project AND space.display_name:Tasks` returns messages that are in spaces with display names containing both `Project` and `Tasks`, whereas `space.display_name:Project OR space.display_name:Tasks` returns messages that are in spaces with display names containing either `Project` or `Tasks` or both. - `space.space_type` supports only the `OR` operator, for example: `space.space_type = \"DIRECT_MESSAGE\" OR space.space_type = \"GROUP_CHAT\"`. - `annotations.user_mentions.user.name` supports the operators `AND` and `OR`, but not a mix of both. For example: `annotations.user_mentions.user.name:\"users/1234567890\" AND annotations.user_mentions.user.name:\"users/0987654321\"` returns only messages that mentions both users, whereas `annotations.user_mentions.user.name:\"users/1234567890\" OR annotations.user_mentions.user.name:\"users/0987654321\"` returns messages that mention either user or both. Parentheses are required to disambiguate operator precedence when combining `AND` and `OR` operators in the same query. For example: `(sender.name=\"users/me\" OR sender.name=\"users/123456\") AND is_unread()`. Otherwise, parentheses are optional. The following example queries are valid: ``` \"Pending reports\" AND create_time >= \"2023-01-01T00:00:00Z\" sender.name = \"users/example@gmail.com\" annotations.user_mentions.user.name:\"users/0987654321\" attachment:* AND space.name = \"spaces/ABCDEFGH\" tasks AND is_unread() AND sender.name = \"users/1234567890\" \"things to do\" \"urgent\" (sender.name = \"users/1234567890\") AND (create_time < \"2023-05-01T00:00:00Z\") tasks AND space.name = \"spaces/ABCDEFGH\" AND has_link() \"project one\" is_unread() space.display_name:Project tasks ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"markupSyntax":{"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"orderBy":{"description":"Optional. How the results list is ordered. Supported attributes to order by are: - `create_time`: Sorts the results by the time of the message creation. Default value. - `relevance`: Sorts the results by relevance. [Developer Preview](https://developers.google.com/workspace/preview). The default ordering is `create_time desc`. Only a single order per query (`create_time` or `relevance`) is supported. Only descending order (`desc`) is supported, and it must be specified after the order attribute.","type":"string"},"pageSize":{"description":"Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 25 are returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.","format":"int32","type":"integer"},"pageToken":{"description":"Optional. A token, received from the previous search messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"view":{"description":"Optional. Specifies what kind of search results view to return. The default is `SEARCH_MESSAGES_VIEW_BASIC`.","enum":["SEARCH_MESSAGES_VIEW_UNSPECIFIED","SEARCH_MESSAGES_VIEW_BASIC","SEARCH_MESSAGES_VIEW_FULL"],"type":"string"}}},"chat_v1_SearchMessagesResponse":{"description":"Response message for searching messages.","type":"object","properties":{"nextPageToken":{"description":"A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.","type":"string"},"results":{"description":"The list of search results that matched the query.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SearchMessageResult"}}}},"chat_v1_SearchSpaceResult":{"description":"A single result item from a space search.","type":"object","properties":{"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_SearchSpacesResponse":{"description":"Response with a list of spaces corresponding to the search spaces request.","type":"object","properties":{"nextPageToken":{"description":"A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages. Only populated when `useAdminAccess` is set to `true`.","type":"string"},"results":{"description":"Output only. The list of search results that matched the query.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_SearchSpaceResult"}},"spaces":{"description":"Deprecated: Please use the new `results` field instead. A page of the requested spaces. This field will be populated only when `useAdminAccess` is set to `true` and deprecated in favor of the new `results` field.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Space"}},"totalSize":{"description":"The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate. Only populated when `useAdminAccess` is set to `true`.","format":"int32","type":"integer"}}},"chat_v1_Section":{"description":"A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).","type":"object","properties":{"header":{"description":"The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"widgets":{"description":"A section must contain at least one widget.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_WidgetMarkup"}}}},"chat_v1_SectionItem":{"description":"A user's defined section item. This is used to represent section items, such as spaces, grouped under a section.","type":"object","properties":{"name":{"description":"Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}`","type":"string"},"space":{"description":"Optional. The space resource name. Format: `spaces/{space}`","type":"string"}}},"chat_v1_SelectionItems":{"description":"List of widget autocomplete results.","type":"object","properties":{"items":{"description":"An array of the SelectionItem objects.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionItem"}}}},"chat_v1_SetUpSpaceRequest":{"description":"Request to create a space and add specified users to it.","type":"object","properties":{"memberships":{"description":"Optional. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 49 memberships (in addition to the caller). For human membership, the `Membership.member` field must contain a `user` with `name` populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the `user.name` can be `users/example@gmail.com`. To invite Gmail users or users from external Google Workspace domains, user's email must be used for `{user}`. For Google group membership, the `Membership.group_member` field must contain a `group` with `name` populated (format `groups/{group}`). You can only add Google groups when setting `Space.spaceType` to `SPACE`. Optional when setting `Space.spaceType` to `SPACE`. Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships. Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Membership"}},"requestId":{"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.","type":"string"},"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_SlashCommand":{"description":"Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat.","type":"object","properties":{"commandId":{"description":"The ID of the slash command.","format":"int64","type":"string"}}},"chat_v1_SlashCommandMetadata":{"description":"Annotation metadata for slash commands (/).","type":"object","properties":{"bot":{"$ref":"#/components/schemas/chat_v1_User"},"commandId":{"description":"The command ID of the invoked slash command.","format":"int64","type":"string"},"commandName":{"description":"The name of the invoked slash command.","type":"string"},"triggersDialog":{"description":"Indicates whether the slash command is for a dialog.","type":"boolean"},"type":{"description":"The type of slash command.","enum":["TYPE_UNSPECIFIED","ADD","INVOKE"],"type":"string"}}},"chat_v1_Space":{"description":"A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.","type":"object","properties":{"accessSettings":{"$ref":"#/components/schemas/chat_v1_AccessSettings"},"adminInstalled":{"description":"Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.","readOnly":true,"type":"boolean"},"createTime":{"description":"Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.","format":"google-datetime","type":"string"},"customer":{"description":"Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.","type":"string"},"displayName":{"description":"Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.","type":"string"},"externalUserAllowed":{"description":"Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.","type":"boolean"},"importMode":{"description":"Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","type":"boolean"},"importModeExpireTime":{"description":"Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode.","format":"google-datetime","readOnly":true,"type":"string"},"lastActiveTime":{"description":"Output only. Timestamp of the last message in the space.","format":"google-datetime","readOnly":true,"type":"string"},"membershipCount":{"$ref":"#/components/schemas/chat_v1_MembershipCount"},"name":{"description":"Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.","type":"string"},"permissionSettings":{"$ref":"#/components/schemas/chat_v1_PermissionSettings"},"predefinedPermissionSettings":{"description":"Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)","enum":["PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED","COLLABORATION_SPACE","ANNOUNCEMENT_SPACE"],"type":"string"},"singleUserBotDm":{"description":"Optional. Whether the space is a DM between a Chat app and a single human.","type":"boolean"},"spaceDetails":{"$ref":"#/components/schemas/chat_v1_SpaceDetails"},"spaceHistoryState":{"description":"Optional. The message history state for messages and threads in this space.","enum":["HISTORY_STATE_UNSPECIFIED","HISTORY_OFF","HISTORY_ON"],"type":"string"},"spaceThreadingState":{"description":"Output only. The threading state in the Chat space.","readOnly":true,"enum":["SPACE_THREADING_STATE_UNSPECIFIED","THREADED_MESSAGES","GROUPED_MESSAGES","UNTHREADED_MESSAGES"],"type":"string"},"spaceType":{"description":"Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.","enum":["SPACE_TYPE_UNSPECIFIED","SPACE","GROUP_CHAT","DIRECT_MESSAGE"],"type":"string"},"spaceUri":{"description":"Output only. The URI for a user to access the space.","readOnly":true,"type":"string"},"threaded":{"description":"Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.","readOnly":true,"type":"boolean"},"type":{"description":"Output only. Deprecated: Use `space_type` instead. The type of a space.","readOnly":true,"enum":["TYPE_UNSPECIFIED","ROOM","DM"],"type":"string"}}},"chat_v1_SpaceBatchUpdatedEventData":{"description":"Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`","type":"object","properties":{"spaces":{"description":"A list of updated spaces.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SpaceUpdatedEventData"}}}},"chat_v1_SpaceDataSource":{"description":"A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"defaultToCurrentSpace":{"description":"If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.","type":"boolean"}}},"chat_v1_SpaceDetails":{"description":"Details about the space including description and rules.","type":"object","properties":{"description":{"description":"Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters.","type":"string"},"guidelines":{"description":"Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters.","type":"string"}}},"chat_v1_SpaceEvent":{"description":"An event that represents a change or activity in a Google Chat space. To learn more, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).","type":"object","properties":{"eventTime":{"description":"Time when the event occurred.","format":"google-datetime","type":"string"},"eventType":{"description":"Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`","type":"string"},"membershipBatchCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipBatchCreatedEventData"},"membershipBatchDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipBatchDeletedEventData"},"membershipBatchUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipBatchUpdatedEventData"},"membershipCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipCreatedEventData"},"membershipDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipDeletedEventData"},"membershipUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipUpdatedEventData"},"messageBatchCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageBatchCreatedEventData"},"messageBatchDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MessageBatchDeletedEventData"},"messageBatchUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageBatchUpdatedEventData"},"messageCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageCreatedEventData"},"messageDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MessageDeletedEventData"},"messageUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageUpdatedEventData"},"name":{"description":"Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","type":"string"},"reactionBatchCreatedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionBatchCreatedEventData"},"reactionBatchDeletedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionBatchDeletedEventData"},"reactionCreatedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionCreatedEventData"},"reactionDeletedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionDeletedEventData"},"spaceBatchUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_SpaceBatchUpdatedEventData"},"spaceUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_SpaceUpdatedEventData"}}},"chat_v1_SpaceNotificationSetting":{"description":"The notification setting of a user in a space.","type":"object","properties":{"muteSetting":{"description":"The space notification mute setting.","enum":["MUTE_SETTING_UNSPECIFIED","UNMUTED","MUTED"],"type":"string"},"name":{"description":"Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","type":"string"},"notificationSetting":{"description":"The notification setting.","enum":["NOTIFICATION_SETTING_UNSPECIFIED","ALL","MAIN_CONVERSATIONS","FOR_YOU","OFF"],"type":"string"}}},"chat_v1_SpaceReadState":{"description":"A user's read state within a space, used to identify read and unread messages.","type":"object","properties":{"lastReadTime":{"description":"Optional. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.","format":"google-datetime","type":"string"},"name":{"description":"Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","type":"string"}}},"chat_v1_SpaceUpdatedEventData":{"description":"Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated`","type":"object","properties":{"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"chat_v1_StringInputs":{"description":"Input parameter for regular widgets. For single-valued widgets, it is a single value list. For multi-valued widgets, such as checkbox, all the values are presented.","type":"object","properties":{"value":{"description":"An list of strings entered by the user.","type":"array","items":{"type":"string"}}}},"chat_v1_TextButton":{"description":"A button with text and `onclick` action.","type":"object","properties":{"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"},"text":{"description":"The text of the button.","type":"string"}}},"chat_v1_TextParagraph":{"description":"A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"object","properties":{"text":{"type":"string"}}},"chat_v1_Thread":{"description":"A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found.","type":"object","properties":{"name":{"description":"Identifier. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`","type":"string"},"threadKey":{"description":"Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead.","type":"string"}}},"chat_v1_ThreadReadState":{"description":"A user's read state within a thread, used to identify read and unread messages.","type":"object","properties":{"lastReadTime":{"description":"The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.","format":"google-datetime","type":"string"},"name":{"description":"Resource name of the thread read state. Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`","type":"string"}}},"chat_v1_TimeInput":{"description":"Time input values.","type":"object","properties":{"hours":{"description":"The hour on a 24-hour clock.","format":"int32","type":"integer"},"minutes":{"description":"The number of minutes past the hour. Valid values are 0 to 59.","format":"int32","type":"integer"}}},"chat_v1_TimeZone":{"description":"The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).","type":"object","properties":{"id":{"description":"The [IANA TZ](https://www.iana.org/time-zones) time zone database code, such as \"America/Toronto\".","type":"string"},"offset":{"description":"The user timezone offset, in milliseconds, from Coordinated Universal Time (UTC).","format":"int32","type":"integer"}}},"chat_v1_UpdatedWidget":{"description":"For `selectionInput` widgets, returns autocomplete suggestions for a multiselect menu.","type":"object","properties":{"suggestions":{"$ref":"#/components/schemas/chat_v1_SelectionItems"},"widget":{"description":"The ID of the updated widget. The ID must match the one for the widget that triggered the update request.","type":"string"}}},"chat_v1_UploadAttachmentRequest":{"description":"Request to upload an attachment.","type":"object","properties":{"filename":{"description":"Required. The filename of the attachment, including the file extension.","type":"string"}}},"chat_v1_UploadAttachmentResponse":{"description":"Response of uploading an attachment.","type":"object","properties":{"attachmentDataRef":{"$ref":"#/components/schemas/chat_v1_AttachmentDataRef"}}},"chat_v1_User":{"description":"If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource (such as in the Messages and Memberships APIs) only populates the `name` and `type` fields for both internal and external users, unless they are members of the space or have prior affinity with the calling user.","type":"object","properties":{"avatarUrl":{"description":"Output only. The user's avatar image URL. When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user.","readOnly":true,"type":"string"},"displayName":{"description":"Output only. The user's display name. Populated for both app authentication and user authentication. This field is always populated for requests made with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user.","readOnly":true,"type":"string"},"domainId":{"description":"Unique identifier of the user's Google Workspace domain.","type":"string"},"email":{"description":"Output only. The user's email address. When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user.","readOnly":true,"type":"string"},"isAnonymous":{"description":"Output only. When `true`, the user is deleted or their profile is not visible, such as when a user is mentioned in a space without being a member and without prior affinity with the calling user.","readOnly":true,"type":"boolean"},"name":{"description":"Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.","type":"string"},"type":{"description":"User type.","enum":["TYPE_UNSPECIFIED","HUMAN","BOT"],"type":"string"}}},"chat_v1_UserMentionMetadata":{"description":"Annotation metadata for user mentions (@).","type":"object","properties":{"type":{"description":"The type of user mention.","enum":["TYPE_UNSPECIFIED","ADD","MENTION"],"type":"string"},"user":{"$ref":"#/components/schemas/chat_v1_User"}}},"chat_v1_WidgetMarkup":{"description":"A widget is a UI element that presents text and images.","type":"object","properties":{"buttons":{"description":"A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Button"}},"image":{"$ref":"#/components/schemas/chat_v1_Image"},"keyValue":{"$ref":"#/components/schemas/chat_v1_KeyValue"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_TextParagraph"}}},"chat_v1_WorkflowDataSourceMarkup":{"description":"* Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google.","type":"object","properties":{"includeVariables":{"description":"Whether to include variables from the previous step in the data source.","type":"boolean"},"type":{"description":"The type of data source.","enum":["UNKNOWN","USER","SPACE","USER_WITH_FREE_FORM"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/chat.spaces":"","https://www.googleapis.com/auth/chat.memberships":"","https://www.googleapis.com/auth/chat.messages":"","https://www.googleapis.com/auth/chat.customemojis":"","https://www.googleapis.com/auth/chat.delete":"","https://www.googleapis.com/auth/chat.users.readstate":"","https://www.googleapis.com/auth/chat.users.spacesettings":"","https://www.googleapis.com/auth/chat.users.sections":"","https://www.googleapis.com/auth/chat.users.availability":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/chat.spaces","https://www.googleapis.com/auth/chat.memberships","https://www.googleapis.com/auth/chat.messages","https://www.googleapis.com/auth/chat.customemojis","https://www.googleapis.com/auth/chat.delete","https://www.googleapis.com/auth/chat.users.readstate","https://www.googleapis.com/auth/chat.users.spacesettings","https://www.googleapis.com/auth/chat.users.sections","https://www.googleapis.com/auth/chat.users.availability"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/chat/v1/rest","service":"chat","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Chat API","version":"v1","description":"The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages."},"servers":[{"url":"https://chat.googleapis.com/"}],"paths":{"/upload/v1/{parent}/attachments:upload":{"post":{"operationId":"chat.media.uploadMedia","x-executor-toolPath":"chat.media.uploadMedia","tags":["Google Chat API"],"description":"Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat). (media upload)","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","schema":{"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_UploadAttachmentResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/customEmojis":{"get":{"operationId":"chat.customEmojis.list","x-executor-toolPath":"chat.customEmojis.list","tags":["Google Chat API"],"description":"Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: ``` creator(\"users/me\") ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: ``` creator(\"users/me\") ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","schema":{"description":"Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","schema":{"description":"Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListCustomEmojisResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis.readonly","https://www.googleapis.com/auth/chat.customemojis"]},"post":{"operationId":"chat.customEmojis.create","x-executor-toolPath":"chat.customEmojis.create","tags":["Google Chat API"],"description":"Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis"]}},"/v1/customEmojis/{customEmojisId}":{"get":{"operationId":"chat.customEmojis.get","x-executor-toolPath":"chat.customEmojis.get","tags":["Google Chat API"],"description":"Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"customEmojisId","in":"path","required":true,"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","schema":{"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis.readonly","https://www.googleapis.com/auth/chat.customemojis"]},"delete":{"operationId":"chat.customEmojis.delete","x-executor-toolPath":"chat.customEmojis.delete","tags":["Google Chat API"],"description":"Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`","parameters":[{"name":"customEmojisId","in":"path","required":true,"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","schema":{"description":"`customEmojisId` of `name` (`customEmojis/{customEmojisId}`). Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.customemojis"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.customemojis"]}},"/v1/media/{resourceName}":{"get":{"operationId":"chat.media.download","x-executor-toolPath":"chat.media.download","tags":["Google Chat API"],"description":"Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Name of the media that is being downloaded. See ReadRequest.resource_name.","schema":{"description":"Name of the media that is being downloaded. See ReadRequest.resource_name.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Media"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages.readonly","https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces":{"get":{"operationId":"chat.spaces.list","x-executor-toolPath":"chat.spaces.list","tags":["Google Chat API"],"description":"Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = \"SPACE\" spaceType = \"GROUP_CHAT\" OR spaceType = \"DIRECT_MESSAGE\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = \"SPACE\" spaceType = \"GROUP_CHAT\" OR spaceType = \"DIRECT_MESSAGE\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSpacesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces.readonly","https://www.googleapis.com/auth/chat.spaces"]},"post":{"operationId":"chat.spaces.create","x-executor-toolPath":"chat.spaces.create","tags":["Google Chat API"],"description":"Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces.create` - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When authenticating as an app, the `space.customer` field must be set in the request. When authenticating as an app, the Chat app is added as a member of the space. However, unlike human authentication, the Chat app is not added as a space manager. By default, the Chat app can be removed from the space by all space members. To allow only space managers to remove the app from a space, set `space.permission_settings.manage_apps` to `managers_allowed`. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":false,"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.","schema":{"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces/{spacesId}":{"get":{"operationId":"chat.spaces.get","x-executor-toolPath":"chat.spaces.get","tags":["Google Chat API"],"description":"Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - `space.access_settings` is only populated when using the `chat.app.spaces` scope. - `space.predefind_permission_settings` and `space.permission_settings` are only populated when using the `chat.app.spaces` scope, and only for spaces the app created.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces.readonly","https://www.googleapis.com/auth/chat.spaces"]},"delete":{"operationId":"chat.spaces.delete","x-executor-toolPath":"chat.spaces.delete","tags":["Google Chat API"],"description":"Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.delete` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.delete` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.delete`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space to delete. Format: `spaces/{space}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space to delete. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.delete"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.delete"]},"patch":{"operationId":"chat.spaces.patch","x-executor-toolPath":"chat.spaces.patch","tags":["Google Chat API"],"description":"Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - To update either `space.predefined_permission_settings` or `space.permission_settings`, the app must be the space creator. - Updating the `space.access_settings.audience` is not supported for app authentication.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership`","schema":{"description":"Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces/{spacesId}/members/{membersId}":{"get":{"operationId":"chat.spaces.members.get","x-executor-toolPath":"chat.spaces.members.get","tags":["Google Chat API"],"description":"Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships.readonly","https://www.googleapis.com/auth/chat.memberships"]},"delete":{"operationId":"chat.spaces.members.delete","x-executor-toolPath":"chat.spaces.members.delete","tags":["Google Chat API"],"description":"Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to remove the calling app from the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Removing a Google Group from a space. - Removing a Chat app from a space. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the Chat app must be the space creator.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]},"patch":{"operationId":"chat.spaces.members.patch","x-executor-toolPath":"chat.spaces.members.patch","tags":["Google Chat API"],"description":"Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role`","schema":{"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]}},"/v1/spaces/{spacesId}/messagePins/{messagePinsId}":{"delete":{"operationId":"chat.spaces.messagePins.delete","x-executor-toolPath":"chat.spaces.messagePins.delete","tags":["Google Chat API"],"description":"Deletes a message pin. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","type":"string"},"allowReserved":true},{"name":"messagePinsId","in":"path","required":true,"description":"`messagePinsId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","schema":{"description":"`messagePinsId` of `name` (`spaces/{spacesId}/messagePins/{messagePinsId}`). Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces/{spacesId}/messages/{messagesId}":{"get":{"operationId":"chat.spaces.messages.get","x-executor-toolPath":"chat.spaces.messages.get","tags":["Google Chat API"],"description":"Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"markupSyntax","in":"query","required":false,"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","schema":{"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages.readonly","https://www.googleapis.com/auth/chat.messages"]},"delete":{"operationId":"chat.spaces.messages.delete","x-executor-toolPath":"chat.spaces.messages.delete","tags":["Google Chat API"],"description":"Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"force","in":"query","required":false,"description":"Optional. When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).","schema":{"description":"Optional. When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]},"patch":{"operationId":"chat.spaces.messages.patch","x-executor-toolPath":"chat.spaces.messages.patch","tags":["Google Chat API"],"description":"Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}`). Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allowMissing","in":"query","required":false,"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","schema":{"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","schema":{"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}":{"delete":{"operationId":"chat.spaces.messages.reactions.delete","x-executor-toolPath":"chat.spaces.messages.reactions.delete","tags":["Google Chat API"],"description":"Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"allowReserved":true},{"name":"messagesId","in":"path","required":true,"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","schema":{"description":"`messagesId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"allowReserved":true},{"name":"reactionsId","in":"path","required":true,"description":"`reactionsId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","schema":{"description":"`reactionsId` of `name` (`spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}`). Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}":{"get":{"operationId":"chat.spaces.spaceEvents.get","x-executor-toolPath":"chat.spaces.spaceEvents.get","tags":["Google Chat API"],"description":"Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","type":"string"},"allowReserved":true},{"name":"spaceEventsId","in":"path","required":true,"description":"`spaceEventsId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","schema":{"description":"`spaceEventsId` of `name` (`spaces/{spacesId}/spaceEvents/{spaceEventsId}`). Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceEvent"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships.readonly","https://www.googleapis.com/auth/chat.messages.readonly","https://www.googleapis.com/auth/chat.spaces.readonly","https://www.googleapis.com/auth/chat.spaces","https://www.googleapis.com/auth/chat.memberships","https://www.googleapis.com/auth/chat.messages"]}},"/v1/spaces:findDirectMessage":{"get":{"operationId":"chat.spaces.findDirectMessage","x-executor-toolPath":"chat.spaces.findDirectMessage","tags":["Google Chat API"],"description":"Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"name","in":"query","required":false,"description":"Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"description":"Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces.readonly","https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces:findGroupChats":{"get":{"operationId":"chat.spaces.findGroupChats","x-executor-toolPath":"chat.spaces.findGroupChats","tags":["Google Chat API"],"description":"Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/workspace/chat/find-group-chats). If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"spaceView","in":"query","required":false,"description":"Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.","schema":{"description":"Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.","enum":["SPACE_VIEW_UNSPECIFIED","SPACE_VIEW_RESOURCE_NAME_ONLY","SPACE_VIEW_EXPANDED"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"users","in":"query","required":false,"description":"Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","schema":{"type":"array","items":{"description":"Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.","type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_FindGroupChatsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships.readonly","https://www.googleapis.com/auth/chat.memberships"]}},"/v1/spaces:search":{"get":{"operationId":"chat.spaces.search","x-executor-toolPath":"chat.spaces.search","tags":["Google Chat API"],"description":"Returns a list of spaces in a Google Workspace organization. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). When `use_admin_access` is set to `false`, the results are limited to spaces where the calling user is a joined member. To search with administrator privileges, set `use_admin_access` to `true`. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - [User authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. - `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. - `create_time` — Denotes the time of the space creation. When `useAdminAccess` is `false`, only `create_time` and `relevance` are supported for ordering. Only `DESC` is supported for these fields in non-admin searches. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are when `useAdminAccess` is set to `true`: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC` When `useAdminAccess` is set to `false`: - `create_time DESC` - `relevance DESC` [Developer Preview](https://developers.google.com/workspace/preview).","schema":{"description":"Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. - `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. - `create_time` — Denotes the time of the space creation. When `useAdminAccess` is `false`, only `create_time` and `relevance` are supported for ordering. Only `DESC` is supported for these fields in non-admin searches. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are when `useAdminAccess` is set to `true`: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC` When `useAdminAccess` is set to `false`: - `create_time DESC` - `relevance DESC` [Developer Preview](https://developers.google.com/workspace/preview).","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000 when `useAdminAccess` is set to `true`. Otherwise, the maximum value is 100. If you use a value more than the maximum value, it's automatically changed to the maximum value.","schema":{"description":"The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000 when `useAdminAccess` is set to `true`. Otherwise, the maximum value is 100. If you use a value more than the maximum value, it's automatically changed to the maximum value.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:\"Hello World\" AND space_type = \"SPACE\" (display_name:\"Hello\" OR display_name:\"Fun\") AND space_type = \"SPACE\" (external_user_allowed = \"true\" AND space_type = \"SPACE\") // Returns an empty response. (external_user_allowed = \"true\" AND display_name:\"Hello\" AND space_type = \"SPACE\") ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Required. A search query. You can search by using the following parameters when `useAdminAccess` is set to `true`: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` When `useAdminAccess` is set to `false`: - `display_name` - `external_user_allowed` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required when `useAdminAccess` is set to `true`, and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. When `useAdminAccess` is set to `false`, `display_name` is required to retrieve meaningful results. Otherwise, the default behavior is to return an empty response. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid when `useAdminAccess` is set to `true`: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ``` The following example queries are valid when `useAdminAccess` is set to `false`: ``` display_name:\"Hello World\" AND space_type = \"SPACE\" (display_name:\"Hello\" OR display_name:\"Fun\") AND space_type = \"SPACE\" (external_user_allowed = \"true\" AND space_type = \"SPACE\") // Returns an empty response. (external_user_allowed = \"true\" AND display_name:\"Hello\" AND space_type = \"SPACE\") ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","schema":{"description":"When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SearchSpacesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces.readonly","https://www.googleapis.com/auth/chat.spaces"]}},"/v1/spaces:setup":{"post":{"operationId":"chat.spaces.setup","x-executor-toolPath":"chat.spaces.setup","tags":["Google Chat API"],"description":"Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SetUpSpaceRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/users/{usersId}/availability":{"get":{"operationId":"chat.users.availability.get","x-executor-toolPath":"chat.users.availability.get","tags":["Google Chat API"],"description":"Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/availability`). Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"`usersId` of `name` (`users/{usersId}/availability`). Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]},"patch":{"operationId":"chat.users.availability.patch","x-executor-toolPath":"chat.users.availability.patch","tags":["Google Chat API"],"description":"Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/availability`). Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"`usersId` of `name` (`users/{usersId}/availability`). Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The list of fields to update. The only field that can be updated is `custom_status`.","schema":{"description":"Required. The list of fields to update. The only field that can be updated is `custom_status`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/users/{usersId}/sections/{sectionsId}":{"delete":{"operationId":"chat.users.sections.delete","x-executor-toolPath":"chat.users.sections.delete","tags":["Google Chat API"],"description":"Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","schema":{"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"sectionsId","in":"path","required":true,"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","schema":{"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Required. The name of the section to delete. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]},"patch":{"operationId":"chat.users.sections.patch","x-executor-toolPath":"chat.users.sections.patch","tags":["Google Chat API"],"description":"Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","schema":{"description":"`usersId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"sectionsId","in":"path","required":true,"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","schema":{"description":"`sectionsId` of `name` (`users/{usersId}/sections/{sectionsId}`). Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The mask to specify which fields to update. Currently supported field paths: - `display_name`","schema":{"description":"Required. The mask to specify which fields to update. Currently supported field paths: - `display_name`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting":{"get":{"operationId":"chat.users.spaces.spaceNotificationSetting.get","x-executor-toolPath":"chat.users.spaces.spaceNotificationSetting.get","tags":["Google Chat API"],"description":"Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceNotificationSetting"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.spacesettings"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.spacesettings"]},"patch":{"operationId":"chat.users.spaces.spaceNotificationSetting.patch","x-executor-toolPath":"chat.users.spaces.spaceNotificationSetting.patch","tags":["Google Chat API"],"description":"Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceNotificationSetting`). Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Supported field paths: - `notification_setting` - `mute_setting`","schema":{"description":"Required. Supported field paths: - `notification_setting` - `mute_setting`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceNotificationSetting"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceNotificationSetting"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.spacesettings"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.spacesettings"]}},"/v1/users/{usersId}/spaces/{spacesId}/spaceReadState":{"get":{"operationId":"chat.users.spaces.getSpaceReadState","x-executor-toolPath":"chat.users.spaces.getSpaceReadState","tags":["Google Chat API"],"description":"Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceReadState"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.readstate"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.readstate"]},"patch":{"operationId":"chat.users.spaces.updateSpaceReadState","x-executor-toolPath":"chat.users.spaces.updateSpaceReadState","tags":["Google Chat API"],"description":"Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/spaceReadState`). Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set `last_read_time` to any value later (larger) than the latest message create time. The `last_read_time` is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.","schema":{"description":"Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set `last_read_time` to any value later (larger) than the latest message create time. The `last_read_time` is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceReadState"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SpaceReadState"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.readstate"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.readstate"]}},"/v1/users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState":{"get":{"operationId":"chat.users.spaces.threads.getThreadReadState","x-executor-toolPath":"chat.users.spaces.threads.getThreadReadState","tags":["Google Chat API"],"description":"Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`","parameters":[{"name":"usersId","in":"path","required":true,"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","schema":{"description":"`usersId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","type":"string"},"allowReserved":true},{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","schema":{"description":"`spacesId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","type":"string"},"allowReserved":true},{"name":"threadsId","in":"path","required":true,"description":"`threadsId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","schema":{"description":"`threadsId` of `name` (`users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState`). Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ThreadReadState"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.readstate"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.readstate"]}},"/v1/{name}":{"put":{"operationId":"chat.spaces.messages.update","x-executor-toolPath":"chat.spaces.messages.update","tags":["Google Chat API"],"description":"Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.","parameters":[{"name":"name","in":"path","required":true,"description":"Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allowMissing","in":"query","required":false,"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","schema":{"description":"Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.","type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","schema":{"description":"Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{name}:markAsActive":{"post":{"operationId":"chat.users.availability.markAsActive","x-executor-toolPath":"chat.users.availability.markAsActive","tags":["Google Chat API"],"description":"Marks user as `ACTIVE` in Google Chat. Sets the user's availability state to `ACTIVE`. The `ACTIVE` state lasts until the specified expiration, at which point the user's state becomes `AWAY`. Note that if the user is actively using Chat, the `ACTIVE` state duration may extend beyond the provided expiration. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the availability to mark as active. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"Required. The resource name of the availability to mark as active. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MarkAsActiveRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/{name}:markAsAway":{"post":{"operationId":"chat.users.availability.markAsAway","x-executor-toolPath":"chat.users.availability.markAsAway","tags":["Google Chat API"],"description":"Marks user as `AWAY` in Google Chat. Sets the user's state to away and is not affected by the user's activity. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"Required. The resource name of the availability to mark as away. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MarkAsAwayRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/{name}:markAsDoNotDisturb":{"post":{"operationId":"chat.users.availability.markAsDoNotDisturb","x-executor-toolPath":"chat.users.availability.markAsDoNotDisturb","tags":["Google Chat API"],"description":"Marks user as `DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","schema":{"description":"Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MarkAsDoNotDisturbRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Availability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.availability"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.availability"]}},"/v1/{name}:move":{"post":{"operationId":"chat.users.sections.items.move","x-executor-toolPath":"chat.users.sections.items.move","tags":["Google Chat API"],"description":"Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}`","schema":{"description":"Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MoveSectionItemRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MoveSectionItemResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{name}:position":{"post":{"operationId":"chat.users.sections.position","x-executor-toolPath":"chat.users.sections.position","tags":["Google Chat API"],"description":"Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"name","in":"path","required":true,"description":"Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`","schema":{"description":"Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_PositionSectionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_PositionSectionResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{parent}/attachments:upload":{"post":{"operationId":"chat.media.upload","x-executor-toolPath":"chat.media.upload","tags":["Google Chat API"],"description":"Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","schema":{"description":"Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_UploadAttachmentRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_UploadAttachmentResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/items":{"get":{"operationId":"chat.users.sections.items.list","x-executor-toolPath":"chat.users.sections.items.list","tags":["Google Chat API"],"description":"Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`","schema":{"description":"Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSectionItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{parent}/members":{"get":{"operationId":"chat.spaces.members.list","x-executor-toolPath":"chat.spaces.members.list","tags":["Google Chat API"],"description":"Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}","schema":{"description":"Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showGroups","in":"query","required":false,"description":"Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.","schema":{"description":"Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.","type":"boolean"},"style":"form","explode":false},{"name":"showInvited","in":"query","required":false,"description":"Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","schema":{"description":"Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListMembershipsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships.readonly","https://www.googleapis.com/auth/chat.memberships"]},"post":{"operationId":"chat.spaces.members.create","x-executor-toolPath":"chat.spaces.members.create","tags":["Google Chat API"],"description":"Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to add the calling app to the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Inviting users external to the Workspace organization that owns the space. - Adding a Google Group to a space. - Adding a Chat app to a space. For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space for which to create the membership. Format: spaces/{space}","schema":{"description":"Required. The resource name of the space for which to create the membership. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useAdminAccess","in":"query","required":false,"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.","schema":{"description":"Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Membership"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships"]}},"/v1/{parent}/messagePins":{"get":{"operationId":"chat.spaces.messagePins.list","x-executor-toolPath":"chat.spaces.messagePins.list","tags":["Google Chat API"],"description":"Lists message pins in a space. Users can pin important messages in spaces for easy access. For more information, see [Pin or unpin a conversation in Google Chat](https://support.google.com/chat/answer/15622437). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins.readonly` - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent space which owns the collection of pinned items Format: `spaces/{space}`","schema":{"description":"Required. The parent space which owns the collection of pinned items Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token received from a previous list message pins call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token received from a previous list message pins call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListMessagePinsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces.readonly","https://www.googleapis.com/auth/chat.spaces"]},"post":{"operationId":"chat.spaces.messagePins.create","x-executor-toolPath":"chat.spaces.messagePins.create","tags":["Google Chat API"],"description":"Creates a message pin. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent space in which to create the message pin. Format: spaces/{space}","schema":{"description":"Required. The parent space in which to create the message pin. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MessagePin"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_MessagePin"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.spaces"]}},"/v1/{parent}/messages":{"get":{"operationId":"chat.spaces.messages.list","x-executor-toolPath":"chat.spaces.messages.list","tags":["Google Chat API"],"description":"Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space to list messages from. Format: `spaces/{space}`","schema":{"description":"Required. The resource name of the space to list messages from. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > \"2012-04-21T11:30:00-04:00\" create_time > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > \"2012-04-21T11:30:00+00:00\" AND create_time < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > \"2012-04-21T11:30:00-04:00\" create_time > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > \"2012-04-21T11:30:00+00:00\" AND create_time < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"markupSyntax","in":"query","required":false,"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","schema":{"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.","schema":{"description":"Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.","schema":{"description":"Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListMessagesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages.readonly","https://www.googleapis.com/auth/chat.messages"]},"post":{"operationId":"chat.spaces.messages.create","x-executor-toolPath":"chat.spaces.messages.create","tags":["Google Chat API"],"description":"Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space in which to create a message. Format: `spaces/{space}`","schema":{"description":"Required. The resource name of the space in which to create a message. Format: `spaces/{space}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"createMessageNotificationOptions.notificationType","in":"query","required":false,"description":"The notification type for the message.","schema":{"description":"The notification type for the message.","enum":["NOTIFICATION_TYPE_NONE","NOTIFICATION_TYPE_FORCE_NOTIFY","NOTIFICATION_TYPE_SILENT"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"messageId","in":"query","required":false,"description":"Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","schema":{"description":"Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"style":"form","explode":false},{"name":"messageReplyOption","in":"query","required":false,"description":"Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.","schema":{"description":"Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.","enum":["MESSAGE_REPLY_OPTION_UNSPECIFIED","REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD","REPLY_MESSAGE_OR_FAIL"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":false,"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call `GetMessage`. - Reusing an existing request ID with a different authenticated user results in an error.","schema":{"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call `GetMessage`. - Reusing an existing request ID with a different authenticated user results in an error.","type":"string"},"style":"form","explode":false},{"name":"threadKey","in":"query","required":false,"description":"Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).","schema":{"description":"Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/messages:search":{"post":{"operationId":"chat.spaces.messages.search","x-executor-toolPath":"chat.spaces.messages.search","tags":["Google Chat API"],"description":"Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set `parent` to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. The returned messages have their `name` field populated with the full resource name, which includes the specific `space` in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Messages that are visible to the authenticated user. - Messages posted by Chat apps in spaces or group chats. - Messages in a Chat app DM. - Messages from blocked users. - Messages in spaces that the caller has muted. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.","schema":{"description":"Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SearchMessagesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_SearchMessagesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages.readonly","https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/reactions":{"get":{"operationId":"chat.spaces.messages.reactions.list","x-executor-toolPath":"chat.spaces.messages.reactions.list","tags":["Google Chat API"],"description":"Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`","schema":{"description":"Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"🙂\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"🙂\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" AND user.name = \"users/{user}\" (emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"🙂\" AND emoji.unicode = \"👍\" emoji.unicode = \"🙂\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"🙂\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"🙂\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR emoji.unicode = \"👍\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" AND user.name = \"users/{user}\" (emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"🙂\" AND emoji.unicode = \"👍\" emoji.unicode = \"🙂\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"🙂\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"🙂\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","schema":{"description":"Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","schema":{"description":"Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListReactionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages.readonly","https://www.googleapis.com/auth/chat.messages"]},"post":{"operationId":"chat.spaces.messages.reactions.create","x-executor-toolPath":"chat.spaces.messages.reactions.create","tags":["Google Chat API"],"description":"Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.create` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`","schema":{"description":"Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Reaction"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_Reaction"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.messages"]}},"/v1/{parent}/sections":{"get":{"operationId":"chat.users.sections.list","x-executor-toolPath":"chat.users.sections.list","tags":["Google Chat API"],"description":"Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}`","schema":{"description":"Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSectionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]},"post":{"operationId":"chat.users.sections.create","x-executor-toolPath":"chat.users.sections.create","tags":["Google Chat API"],"description":"Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent resource name where the section is created. Format: `users/{user}`","schema":{"description":"Required. The parent resource name where the section is created. Format: `users/{user}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.users.sections"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.users.sections"]}},"/v1/{parent}/spaceEvents":{"get":{"operationId":"chat.spaces.spaceEvents.list","x-executor-toolPath":"chat.spaces.spaceEvents.list","tags":["Google Chat API"],"description":"Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.","schema":{"description":"Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","schema":{"description":"Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.","schema":{"description":"Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","schema":{"description":"Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chat_v1_ListSpaceEventsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.spaces"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.memberships"]},{"googleOAuth2":["https://www.googleapis.com/auth/chat.messages"]}],"x-google-scopes":["https://www.googleapis.com/auth/chat.memberships.readonly","https://www.googleapis.com/auth/chat.messages.readonly","https://www.googleapis.com/auth/chat.spaces.readonly","https://www.googleapis.com/auth/chat.spaces","https://www.googleapis.com/auth/chat.memberships","https://www.googleapis.com/auth/chat.messages"]}}},"components":{"schemas":{"chat_v1_AccessPermissionSetting":{"description":"An access permission setting.","type":"object","properties":{"principals":{"description":"Optional. Unordered list. Allowed principals for this permission.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Principal"}}}},"chat_v1_AccessPermissionSettings":{"description":"Access permission settings for a space.","type":"object","properties":{"discoverSpaceSetting":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSetting"},"joinSpaceSetting":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSetting"},"viewSpaceMembershipSetting":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSetting"}}},"chat_v1_AccessSettings":{"description":"Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space.","type":"object","properties":{"accessPermissionSettings":{"$ref":"#/components/schemas/chat_v1_AccessPermissionSettings"},"accessState":{"description":"Output only. Indicates the access state of the space.","readOnly":true,"enum":["ACCESS_STATE_UNSPECIFIED","PRIVATE","DISCOVERABLE"],"type":"string"},"audience":{"description":"Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","type":"string"}}},"chat_v1_AccessoryWidget":{"description":"One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"}}},"chat_v1_ActionParameter":{"description":"List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.","type":"object","properties":{"key":{"description":"The name of the parameter for the action script.","type":"string"},"value":{"description":"The value of the parameter.","type":"string"}}},"chat_v1_ActionResponse":{"description":"Parameters that a Chat app can use to configure how its response is posted.","type":"object","properties":{"dialogAction":{"$ref":"#/components/schemas/chat_v1_DialogAction"},"type":{"description":"Input only. The type of Chat app response.","enum":["TYPE_UNSPECIFIED","NEW_MESSAGE","UPDATE_MESSAGE","UPDATE_USER_MESSAGE_CARDS","REQUEST_CONFIG","DIALOG","UPDATE_WIDGET"],"type":"string"},"updatedWidget":{"$ref":"#/components/schemas/chat_v1_UpdatedWidget"},"url":{"description":"Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)","type":"string"}}},"chat_v1_ActionStatus":{"description":"Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs).","type":"object","properties":{"statusCode":{"description":"The status code.","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","UNAUTHENTICATED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS"],"type":"string"},"userFacingMessage":{"description":"The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent.","type":"string"}}},"chat_v1_Annotation":{"description":"Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```","type":"object","properties":{"customEmojiMetadata":{"$ref":"#/components/schemas/chat_v1_CustomEmojiMetadata"},"length":{"description":"Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.","format":"int32","type":"integer"},"richLinkMetadata":{"$ref":"#/components/schemas/chat_v1_RichLinkMetadata"},"slashCommand":{"$ref":"#/components/schemas/chat_v1_SlashCommandMetadata"},"startIndex":{"description":"Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.","format":"int32","type":"integer"},"type":{"description":"The type of this annotation.","enum":["ANNOTATION_TYPE_UNSPECIFIED","USER_MENTION","SLASH_COMMAND","RICH_LINK","CUSTOM_EMOJI"],"type":"string"},"userMention":{"$ref":"#/components/schemas/chat_v1_UserMentionMetadata"}}},"chat_v1_AppCommandMetadata":{"description":"Metadata about a [Chat app command](https://developers.google.com/workspace/chat/commands).","type":"object","properties":{"appCommandId":{"description":"The ID for the command specified in the Chat API configuration.","format":"int32","type":"integer"},"appCommandType":{"description":"The type of Chat app command.","enum":["APP_COMMAND_TYPE_UNSPECIFIED","SLASH_COMMAND","QUICK_COMMAND","MESSAGE_ACTION"],"type":"string"}}},"chat_v1_AttachedGif":{"description":"A GIF image that's specified by a URL.","type":"object","properties":{"uri":{"description":"Output only. The URL that hosts the GIF image.","readOnly":true,"type":"string"}}},"chat_v1_Attachment":{"description":"An attachment in Google Chat.","type":"object","properties":{"attachmentDataRef":{"$ref":"#/components/schemas/chat_v1_AttachmentDataRef"},"contentName":{"description":"Output only. The original file name for the content, not the full path.","readOnly":true,"type":"string"},"contentType":{"description":"Output only. The content type (MIME type) of the file.","readOnly":true,"type":"string"},"downloadUri":{"description":"Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content.","readOnly":true,"type":"string"},"driveDataRef":{"$ref":"#/components/schemas/chat_v1_DriveDataRef"},"name":{"description":"Identifier. Resource name of the attachment. Format: `spaces/{space}/messages/{message}/attachments/{attachment}`.","type":"string"},"source":{"description":"Output only. The source of the attachment.","readOnly":true,"enum":["SOURCE_UNSPECIFIED","DRIVE_FILE","UPLOADED_CONTENT"],"type":"string"},"thumbnailUri":{"description":"Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.","readOnly":true,"type":"string"}}},"chat_v1_AttachmentDataRef":{"description":"A reference to the attachment data.","type":"object","properties":{"attachmentUploadToken":{"description":"Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.","type":"string"},"resourceName":{"description":"Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.","type":"string"}}},"chat_v1_Audience":{"description":"A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience).","type":"object","properties":{"name":{"description":"The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.","type":"string"}}},"chat_v1_Availability":{"description":"Represents a user's current availability information in Google Chat, including their state (for example, Active, Away, Do Not Disturb) and any custom status.","type":"object","properties":{"customStatus":{"$ref":"#/components/schemas/chat_v1_CustomStatus"},"doNotDisturbMetadata":{"$ref":"#/components/schemas/chat_v1_DoNotDisturbMetadata"},"name":{"description":"Identifier. Resource name of the user's availability. Format: `users/{user}/availability` `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`.","type":"string"},"state":{"description":"Output only. The user's current availability state.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","IDLE","AWAY","DO_NOT_DISTURB"],"type":"string"}}},"chat_v1_Button":{"description":"A button. Can be a text button or an image button.","type":"object","properties":{"imageButton":{"$ref":"#/components/schemas/chat_v1_ImageButton"},"textButton":{"$ref":"#/components/schemas/chat_v1_TextButton"}}},"chat_v1_CalendarEventLinkData":{"description":"Data for Calendar event links.","type":"object","properties":{"calendarId":{"description":"The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.","type":"string"},"eventId":{"description":"The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.","type":"string"}}},"chat_v1_Card":{"description":"A card is a UI element that can contain UI widgets such as text and images.","type":"object","properties":{"cardActions":{"description":"The actions of this card.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_CardAction"}},"header":{"$ref":"#/components/schemas/chat_v1_CardHeader"},"name":{"description":"Name of the card.","type":"string"},"sections":{"description":"Sections are separated by a line divider.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Section"}}}},"chat_v1_CardAction":{"description":"A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser. Not supported by Google Chat apps.","type":"object","properties":{"actionLabel":{"description":"The label used to be displayed in the action menu item.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"}}},"chat_v1_CardHeader":{"type":"object","properties":{"imageStyle":{"description":"The image's type (for example, square border or circular border).","enum":["IMAGE_STYLE_UNSPECIFIED","IMAGE","AVATAR"],"type":"string"},"imageUrl":{"description":"The URL of the image in the card header.","type":"string"},"subtitle":{"description":"The subtitle of the card header.","type":"string"},"title":{"description":"The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines.","type":"string"}}},"chat_v1_CardWithId":{"description":"A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)","type":"object","properties":{"card":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Card"},"cardId":{"description":"Required if the message contains multiple cards. A unique identifier for a card in a message.","type":"string"}}},"chat_v1_ChatAppLogEntry":{"description":"JSON payload of error messages. If the Cloud Logging API is enabled, these error messages are logged to [Google Cloud Logging](https://cloud.google.com/logging/docs).","type":"object","properties":{"deployment":{"description":"The deployment that caused the error. For Chat apps built in Apps Script, this is the deployment ID defined by Apps Script.","type":"string"},"deploymentFunction":{"description":"The unencrypted `callback_method` name that was running when the error was encountered.","type":"string"},"error":{"$ref":"#/components/schemas/chat_v1_Status"}}},"chat_v1_ChatClientDataSourceMarkup":{"description":"For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"spaceDataSource":{"$ref":"#/components/schemas/chat_v1_SpaceDataSource"}}},"chat_v1_ChatSpaceLinkData":{"description":"Data for Chat space links.","type":"object","properties":{"message":{"description":"The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`","type":"string"},"space":{"description":"The space of the linked Chat space resource. Format: `spaces/{space}`","type":"string"},"thread":{"description":"The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`","type":"string"}}},"chat_v1_Color":{"description":"Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...","type":"object","properties":{"alpha":{"description":"The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).","format":"float","type":"number"},"blue":{"description":"The amount of blue in the color as a value in the interval [0, 1].","format":"float","type":"number"},"green":{"description":"The amount of green in the color as a value in the interval [0, 1].","format":"float","type":"number"},"red":{"description":"The amount of red in the color as a value in the interval [0, 1].","format":"float","type":"number"}}},"chat_v1_CommonEventObject":{"description":"The common event object is the portion of the overall event object that carries general, host-independent information to the add-on from the user's client. This information includes details such as the user's locale, host app, and platform. In addition to homepage and contextual triggers, add-ons construct and pass event objects to [action callback functions](https://developers.google.com/workspace/add-ons/concepts/actions#callback_functions) when the user interacts with widgets. Your add-on's callback function can query the common event object to determine the contents of open widgets in the user's client. For example, your add-on can locate the text a user has entered into a [TextInput](https://developers.google.com/apps-script/reference/card-service/text-input) widget in the `eventObject.commentEventObject.formInputs` object. For Chat apps, the name of the function that the user invoked when interacting with a widget.","type":"object","properties":{"formInputs":{"description":"A map containing the current values of the widgets in the displayed card. The map keys are the string IDs assigned with each widget. The structure of the map value object is dependent on the widget type: **Note**: The following examples are formatted for Apps Script's V8 runtime. If you're using Rhino runtime, you must add `[\"\"]` after the value. For example, instead of `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`, format the event object as `e.commonEventObject.formInputs.employeeName[\"\"].stringInputs.value[0]`. To learn more about runtimes in Apps Script, see the [V8 Runtime Overview](https://developers.google.com/apps-script/guides/v8-runtime). * Single-valued widgets (for example, a text box): a list of strings (only one element). **Example**: for a text input widget with `employeeName` as its ID, access the text input value with: `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`. * Multi-valued widgets (for example, checkbox groups): a list of strings. **Example**: for a multi-value widget with `participants` as its ID, access the value array with: `e.commonEventObject.formInputs.participants.stringInputs.value`. * **A date-time picker**: a [`DateTimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input). **Example**: For a picker with an ID of `myDTPicker`, access the [`DateTimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input) object using `e.commonEventObject.formInputs.myDTPicker.dateTimeInput`. * **A date-only picker**: a [`DateInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input). **Example**: For a picker with an ID of `myDatePicker`, access the [`DateInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input) object using `e.commonEventObject.formInputs.myDatePicker.dateInput`. * **A time-only picker**: a [`TimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input). **Example**: For a picker with an ID of `myTimePicker`, access the [`TimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input) object using `e.commonEventObject.formInputs.myTimePicker.timeInput`.","type":"object","additionalProperties":{"$ref":"#/components/schemas/chat_v1_Inputs"}},"hostApp":{"description":"Indicates the host app the add-on is active in when the event object is generated. Possible values include the following: * `GMAIL` * `CALENDAR` * `DRIVE` * `DOCS` * `SHEETS` * `SLIDES` * `CHAT`","enum":["UNSPECIFIED_HOST_APP","GMAIL","CALENDAR","DRIVE","DEMO","DOCS","MEET","SHEETS","SLIDES","DRAWINGS","CHAT"],"type":"string"},"invokedFunction":{"description":"Name of the function to invoke. This field doesn't populate for Google Workspace Add-ons that extend Google Chat. Instead, to receive function data like identifiers, add-ons that extend Chat should use the `parameters` field. See [Build interactive interfaces for Chat apps](https://developers.google.com/workspace/add-ons/chat/build).","type":"string"},"parameters":{"description":"Any additional parameters you supply to an action using [`actionParameters`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#google.apps.card.v1.Action.ActionParameter) or [`Action.setParameters()`](https://developers.google.com/apps-script/reference/card-service/action#setparametersparameters). **Developer Preview:** For [add-ons that extend Google Chat](https://developers.google.com/workspace/add-ons/chat), to suggest items based on what the users type in multiselect menus, use the value of the `\"autocomplete_widget_query\"` key (`event.commonEventObject.parameters[\"autocomplete_widget_query\"]`). You can use this value to query a database and suggest selectable items to users as they type. For details, see [Collect and process information from Google Chat users](https://developers.google.com/workspace/add-ons/chat/collect-information).","type":"object","additionalProperties":{"type":"string"}},"platform":{"description":"The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.","enum":["UNKNOWN_PLATFORM","WEB","IOS","ANDROID"],"type":"string"},"timeZone":{"$ref":"#/components/schemas/chat_v1_TimeZone"},"userLocale":{"description":"**Disabled by default.** The user's language and country/region identifier in the format of [ISO 639](https://wikipedia.org/wiki/ISO_639_macrolanguage) language code-[ISO 3166](https://wikipedia.org/wiki/ISO_3166) country/region code. For example, `en-US`. To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details.","type":"string"}}},"chat_v1_CompleteImportSpaceRequest":{"description":"Request message for completing the import process for a space.","type":"object"},"chat_v1_CompleteImportSpaceResponse":{"description":"Response message for completing the import process for a space.","type":"object","properties":{"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_CustomEmoji":{"description":"Represents a [custom emoji](https://support.google.com/chat/answer/12800149).","type":"object","properties":{"emojiName":{"description":"Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`","type":"string"},"name":{"description":"Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`","type":"string"},"payload":{"$ref":"#/components/schemas/chat_v1_CustomEmojiPayload"},"temporaryImageUri":{"description":"Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.","readOnly":true,"type":"string"},"uid":{"description":"Output only. Unique key for the custom emoji resource.","readOnly":true,"type":"string"}}},"chat_v1_CustomEmojiMetadata":{"description":"Annotation metadata for custom emoji.","type":"object","properties":{"customEmoji":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}}},"chat_v1_CustomEmojiPayload":{"description":"Payload data for the custom emoji.","type":"object","properties":{"fileContent":{"description":"Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.","format":"byte","type":"string"},"filename":{"description":"Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`.","type":"string"}}},"chat_v1_CustomStatus":{"description":"Represents a user's custom status in Google Chat. This includes a short text message with an optional emoji that a user sets to give more context about their availability.","type":"object","properties":{"emoji":{"$ref":"#/components/schemas/chat_v1_Emoji"},"expireTime":{"description":"The timestamp when the custom status expires.","format":"google-datetime","type":"string"},"text":{"description":"Required. The text of the custom status. This will be a string with maximum length of 64.","type":"string"},"ttl":{"description":"Input only. The time-to-live duration after which the custom status expires.","format":"google-duration","type":"string"}}},"chat_v1_DateInput":{"description":"Date input values.","type":"object","properties":{"msSinceEpoch":{"description":"Time since epoch time, in milliseconds.","format":"int64","type":"string"}}},"chat_v1_DateTimeInput":{"description":"Date and time input values.","type":"object","properties":{"hasDate":{"description":"Whether the `datetime` input includes a calendar date.","type":"boolean"},"hasTime":{"description":"Whether the `datetime` input includes a timestamp.","type":"boolean"},"msSinceEpoch":{"description":"Time since epoch time, in milliseconds.","format":"int64","type":"string"}}},"chat_v1_DeletionMetadata":{"description":"Information about a deleted message. A message is deleted when `delete_time` is set.","type":"object","properties":{"deletionType":{"description":"Indicates who deleted the message.","enum":["DELETION_TYPE_UNSPECIFIED","CREATOR","SPACE_OWNER","ADMIN","APP_MESSAGE_EXPIRY","CREATOR_VIA_APP","SPACE_OWNER_VIA_APP","SPACE_MEMBER"],"type":"string"}}},"chat_v1_DeprecatedEvent":{"description":" A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). Note: This event is only used for [Chat interaction events](https://developers.google.com/workspace/chat/receive-respond-interactions). If your Chat app is built as a [Google Workspace add-on](https://developers.google.com/workspace/add-ons/chat/build), see [Chat event objects](https://developers.google.com/workspace/add-ons/concepts/event-objects#chat-event-object) in the add-ons documentation.","type":"object","properties":{"action":{"$ref":"#/components/schemas/chat_v1_FormAction"},"appCommandMetadata":{"$ref":"#/components/schemas/chat_v1_AppCommandMetadata"},"common":{"$ref":"#/components/schemas/chat_v1_CommonEventObject"},"configCompleteRedirectUrl":{"description":"This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).","type":"string"},"dialogEventType":{"description":"The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.","enum":["TYPE_UNSPECIFIED","REQUEST_DIALOG","SUBMIT_DIALOG","CANCEL_DIALOG"],"type":"string"},"eventTime":{"description":"The timestamp indicating when the interaction event occurred.","format":"google-datetime","type":"string"},"isDialogEvent":{"description":"For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs).","type":"boolean"},"message":{"$ref":"#/components/schemas/chat_v1_Message"},"space":{"$ref":"#/components/schemas/chat_v1_Space"},"thread":{"$ref":"#/components/schemas/chat_v1_Thread"},"threadKey":{"description":"The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.","type":"string"},"token":{"description":"A secret value that legacy Chat apps can use to verify if a request is from Google. Google randomly generates the token, and its value remains static. You can obtain, revoke, or regenerate the token from the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat) in the Google Cloud Console. Modern Chat apps don't use this field. It is absent from API responses and the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).","type":"string"},"type":{"description":"The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.","enum":["UNSPECIFIED","MESSAGE","ADDED_TO_SPACE","REMOVED_FROM_SPACE","CARD_CLICKED","WIDGET_UPDATED","APP_COMMAND"],"type":"string"},"user":{"$ref":"#/components/schemas/chat_v1_User"}}},"chat_v1_Dialog":{"description":"Wrapper around the card body of the dialog.","type":"object","properties":{"body":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Card"}}},"chat_v1_DialogAction":{"description":"Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and request status code.","type":"object","properties":{"actionStatus":{"$ref":"#/components/schemas/chat_v1_ActionStatus"},"dialog":{"$ref":"#/components/schemas/chat_v1_Dialog"}}},"chat_v1_DoNotDisturbMetadata":{"description":"Metadata associated with the `DO_NOT_DISTURB` availability state, specifying when the state is set to expire.","type":"object","properties":{"expirationTime":{"description":"Output only. Timestamp until which the user should be marked as DO_NOT_DISTURB. This can be maximum of 1 year in the future.","format":"google-datetime","readOnly":true,"type":"string"}}},"chat_v1_DriveDataRef":{"description":"A reference to the data of a drive attachment.","type":"object","properties":{"driveFileId":{"description":"The ID for the drive file. Use with the Drive API.","type":"string"}}},"chat_v1_DriveLinkData":{"description":"Data for Google Drive links.","type":"object","properties":{"driveDataRef":{"$ref":"#/components/schemas/chat_v1_DriveDataRef"},"mimeType":{"description":"The mime type of the linked Google Drive resource.","type":"string"}}},"chat_v1_Emoji":{"description":"An emoji that is used as a reaction to a message.","type":"object","properties":{"customEmoji":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"},"unicode":{"description":"Optional. A basic emoji represented by a unicode string.","type":"string"}}},"chat_v1_EmojiReactionSummary":{"description":"The number of people who reacted to a message with a specific emoji.","type":"object","properties":{"emoji":{"$ref":"#/components/schemas/chat_v1_Emoji"},"reactionCount":{"description":"Output only. The total number of reactions using the associated emoji.","format":"int32","readOnly":true,"type":"integer"}}},"chat_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"chat_v1_FindGroupChatsResponse":{"description":"A response containing group chat spaces with exactly the calling user and the requested users.","type":"object","properties":{"nextPageToken":{"description":"A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"},"spaces":{"description":"List of spaces in the requested (or first) page.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"chat_v1_FormAction":{"description":"A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.","type":"object","properties":{"actionMethodName":{"description":"The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.","type":"string"},"parameters":{"description":"List of action parameters.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_ActionParameter"}}}},"chat_v1_ForwardedMetadata":{"description":"Metadata about the source space from which a message was forwarded.","type":"object","properties":{"space":{"description":"Output only. The resource name of the source space. Format: spaces/{space}","readOnly":true,"type":"string"},"spaceDisplayName":{"description":"Output only. The display name of the source space or DM at the time of forwarding. For `SPACE`, this is the space name. For `DIRECT_MESSAGE`, this is the other participant's name (e.g., \"User A\"). For `GROUP_CHAT`, this is a generated name based on members' first names, limited to 5 including the creator (e.g., \"User A, User B\").","readOnly":true,"type":"string"}}},"chat_v1_GoogleAppsCardV1Action":{"description":"An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"allWidgetsAreRequired":{"description":"Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"boolean"},"function":{"description":"A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"interaction":{"description":"Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):","enum":["INTERACTION_UNSPECIFIED","OPEN_DIALOG"],"type":"string"},"loadIndicator":{"description":"Specifies the loading indicator that the action displays while making the call to the action.","enum":["SPINNER","NONE"],"type":"string"},"parameters":{"description":"List of action parameters.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ActionParameter"}},"persistValues":{"description":"Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.","type":"boolean"},"requiredWidgets":{"description":"Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"array","items":{"type":"string"}}}},"chat_v1_GoogleAppsCardV1ActionParameter":{"description":"List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"key":{"description":"The name of the parameter for the action script.","type":"string"},"value":{"description":"The value of the parameter.","type":"string"}}},"chat_v1_GoogleAppsCardV1BorderStyle":{"description":"The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"cornerRadius":{"description":"The corner radius for the border.","format":"int32","type":"integer"},"strokeColor":{"$ref":"#/components/schemas/chat_v1_Color"},"type":{"description":"The border type.","enum":["BORDER_TYPE_UNSPECIFIED","NO_BORDER","STROKE"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Button":{"description":"A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat\".","type":"string"},"color":{"$ref":"#/components/schemas/chat_v1_Color"},"disabled":{"description":"If `true`, the button is displayed in an inactive state and doesn't respond to user actions.","type":"boolean"},"icon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"text":{"description":"The text displayed inside the button.","type":"string"},"type":{"description":"Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored.","enum":["TYPE_UNSPECIFIED","OUTLINED","FILLED","FILLED_TONAL","BORDERLESS"],"type":"string"}}},"chat_v1_GoogleAppsCardV1ButtonList":{"description":"A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"buttons":{"description":"An array of buttons.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"}}}},"chat_v1_GoogleAppsCardV1Card":{"description":"A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```","type":"object","properties":{"cardActions":{"description":"The card's actions. Actions are added to the card's toolbar menu. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` \"card_actions\": [ { \"actionLabel\": \"Settings\", \"onClick\": { \"action\": { \"functionName\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"LoadIndicator.SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardAction"}},"displayStyle":{"description":"In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","enum":["DISPLAY_STYLE_UNSPECIFIED","PEEK","REPLACE"],"type":"string"},"expressionData":{"description":"The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ExpressionData"}},"fixedFooter":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardFixedFooter"},"header":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardHeader"},"name":{"description":"Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","type":"string"},"peekCardHeader":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CardHeader"},"sectionDividerStyle":{"description":"The divider style between the header, sections and footer.","enum":["DIVIDER_STYLE_UNSPECIFIED","SOLID_DIVIDER","NO_DIVIDER"],"type":"string"},"sections":{"description":"Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Section"}}}},"chat_v1_GoogleAppsCardV1CardAction":{"description":"A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","type":"object","properties":{"actionLabel":{"description":"The label that displays as the action menu item.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"}}},"chat_v1_GoogleAppsCardV1CardFixedFooter":{"description":"A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"primaryButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"secondaryButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"}}},"chat_v1_GoogleAppsCardV1CardHeader":{"description":"Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"imageAltText":{"description":"The alternative text of this image that's used for accessibility.","type":"string"},"imageType":{"description":"The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","enum":["SQUARE","CIRCLE"],"type":"string"},"imageUrl":{"description":"The HTTPS URL of the image in the card header.","type":"string"},"subtitle":{"description":"The subtitle of the card header. If specified, appears on its own line below the `title`.","type":"string"},"title":{"description":"Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.","type":"string"}}},"chat_v1_GoogleAppsCardV1Carousel":{"description":"A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Third text paragraph in carousel\", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"carouselCards":{"description":"A list of cards included in the carousel.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CarouselCard"}}}},"chat_v1_GoogleAppsCardV1CarouselCard":{"description":"A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"footerWidgets":{"description":"A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1NestedWidget"}},"widgets":{"description":"A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1NestedWidget"}}}},"chat_v1_GoogleAppsCardV1Chip":{"description":"A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat\".","type":"string"},"disabled":{"description":"Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.","type":"boolean"},"enabled":{"description":"Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.","type":"boolean"},"icon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"label":{"description":"The text displayed inside the chip.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"}}},"chat_v1_GoogleAppsCardV1ChipList":{"description":"A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"chips":{"description":"An array of chips.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Chip"}},"layout":{"description":"Specified chip list layout.","enum":["LAYOUT_UNSPECIFIED","WRAPPED","HORIZONTAL_SCROLLABLE"],"type":"string"}}},"chat_v1_GoogleAppsCardV1CollapseControl":{"description":"Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"collapseButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"expandButton":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"horizontalAlignment":{"description":"The horizontal alignment of the expand and collapse button.","enum":["HORIZONTAL_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Column":{"description":"A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)","type":"object","properties":{"horizontalAlignment":{"description":"Specifies whether widgets align to the left, right, or center of a column.","enum":["HORIZONTAL_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"horizontalSizeStyle":{"description":"Specifies how a column fills the width of the card.","enum":["HORIZONTAL_SIZE_STYLE_UNSPECIFIED","FILL_AVAILABLE_SPACE","FILL_MINIMUM_SPACE"],"type":"string"},"verticalAlignment":{"description":"Specifies whether widgets align to the top, bottom, or center of a column.","enum":["VERTICAL_ALIGNMENT_UNSPECIFIED","CENTER","TOP","BOTTOM"],"type":"string"},"widgets":{"description":"An array of widgets included in a column. Widgets appear in the order that they are specified.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Widgets"}}}},"chat_v1_GoogleAppsCardV1Columns":{"description":"The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event.","type":"object","properties":{"columnItems":{"description":"An array of columns. You can include up to 2 columns in a card or dialog.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Column"}}}},"chat_v1_GoogleAppsCardV1CommonWidgetAction":{"description":"Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"updateVisibilityAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1UpdateVisibilityAction"}}},"chat_v1_GoogleAppsCardV1Condition":{"description":"Represents a condition that can be used to trigger an action. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"actionRuleId":{"description":"The unique identifier of the ActionRule.","type":"string"},"expressionDataCondition":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ExpressionDataCondition"}}},"chat_v1_GoogleAppsCardV1DataSourceConfig":{"description":"A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.","type":"object","properties":{"minCharactersTrigger":{"description":"The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).","format":"int32","type":"integer"},"platformDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1PlatformDataSource"},"remoteDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"}}},"chat_v1_GoogleAppsCardV1DateTimePicker":{"description":"Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"hostAppDataSource":{"$ref":"#/components/schemas/chat_v1_HostAppDataSourceMarkup"},"label":{"description":"The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`.","type":"string"},"name":{"description":"The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"timezoneOffsetDate":{"description":"The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.","format":"int32","type":"integer"},"type":{"description":"Whether the widget supports inputting a date, a time, or the date and time.","enum":["DATE_AND_TIME","DATE_ONLY","TIME_ONLY"],"type":"string"},"valueMsEpoch":{"description":"The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).","format":"int64","type":"string"}}},"chat_v1_GoogleAppsCardV1DecoratedText":{"description":"A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"bottomLabel":{"description":"The text that appears below `text`. Always wraps.","type":"string"},"bottomLabelText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"button":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Button"},"contentText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"endIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"icon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"startIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"startIconVerticalAlignment":{"description":"Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):","enum":["VERTICAL_ALIGNMENT_UNSPECIFIED","TOP","MIDDLE","BOTTOM"],"type":"string"},"switchControl":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SwitchControl"},"text":{"description":"Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"topLabel":{"description":"The text that appears above `text`. Always truncates.","type":"string"},"topLabelText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"wrapText":{"description":"The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.","type":"boolean"}}},"chat_v1_GoogleAppsCardV1Divider":{"description":"Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` \"divider\": {} ```","type":"object"},"chat_v1_GoogleAppsCardV1EventAction":{"description":"Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"actionRuleId":{"description":"The unique identifier of the ActionRule.","type":"string"},"commonWidgetAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CommonWidgetAction"},"postEventTriggers":{"description":"The list of triggers that will be triggered after the EventAction is executed.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Trigger"}}}},"chat_v1_GoogleAppsCardV1ExpressionData":{"description":"Represents the data that is used to evaluate an expression. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"conditions":{"description":"The list of conditions that are determined by the expression evaluation result.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Condition"}},"eventActions":{"description":"The list of actions that the ExpressionData can be used.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1EventAction"}},"expression":{"description":"The uncompiled expression.","type":"string"},"id":{"description":"The unique identifier of the ExpressionData.","type":"string"}}},"chat_v1_GoogleAppsCardV1ExpressionDataCondition":{"description":"Represents a condition that is evaluated using CEL. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"conditionType":{"description":"The type of the condition.","enum":["CONDITION_TYPE_UNSPECIFIED","EXPRESSION_EVALUATION_SUCCESS","EXPRESSION_EVALUATION_FAILURE"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Grid":{"description":"Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```","type":"object","properties":{"borderStyle":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1BorderStyle"},"columnCount":{"description":"The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).","format":"int32","type":"integer"},"items":{"description":"The items to display in the grid.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1GridItem"}},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"title":{"description":"The text that displays in the grid header.","type":"string"}}},"chat_v1_GoogleAppsCardV1GridItem":{"description":"Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"id":{"description":"A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.","type":"string"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ImageComponent"},"layout":{"description":"The layout to use for the grid item.","enum":["GRID_ITEM_LAYOUT_UNSPECIFIED","TEXT_BELOW","TEXT_ABOVE"],"type":"string"},"subtitle":{"description":"The grid item's subtitle.","type":"string"},"title":{"description":"The grid item's title.","type":"string"}}},"chat_v1_GoogleAppsCardV1Icon":{"description":"An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.","type":"string"},"iconUrl":{"description":"Display a custom icon hosted at an HTTPS URL. For example: ``` \"iconUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\" ``` Supported file types include `.png` and `.jpg`.","type":"string"},"imageType":{"description":"The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.","enum":["SQUARE","CIRCLE"],"type":"string"},"knownIcon":{"description":"Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).","type":"string"},"materialIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1MaterialIcon"}}},"chat_v1_GoogleAppsCardV1Image":{"description":"An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The alternative text of this image that's used for accessibility.","type":"string"},"imageUrl":{"description":"The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"}}},"chat_v1_GoogleAppsCardV1ImageComponent":{"description":"Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"altText":{"description":"The accessibility label for the image.","type":"string"},"borderStyle":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1BorderStyle"},"cropStyle":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ImageCropStyle"},"imageUri":{"description":"The image URL.","type":"string"}}},"chat_v1_GoogleAppsCardV1ImageCropStyle":{"description":"Represents the crop style applied to an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```","type":"object","properties":{"aspectRatio":{"description":"The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```","format":"double","type":"number"},"type":{"description":"The crop type.","enum":["IMAGE_CROP_TYPE_UNSPECIFIED","SQUARE","CIRCLE","RECTANGLE_CUSTOM","RECTANGLE_4_3"],"type":"string"}}},"chat_v1_GoogleAppsCardV1MaterialIcon":{"description":"A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { \"name\": \"check_box\", \"fill\": true, \"weight\": 300, \"grade\": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"fill":{"description":"Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.","type":"boolean"},"grade":{"description":"Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.","format":"int32","type":"integer"},"name":{"description":"The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.","type":"string"},"weight":{"description":"The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.","format":"int32","type":"integer"}}},"chat_v1_GoogleAppsCardV1NestedWidget":{"description":"A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Image"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"}}},"chat_v1_GoogleAppsCardV1OnClick":{"description":"Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"action":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"card":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Card"},"openDynamicLinkAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"openLink":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OpenLink"},"overflowMenu":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OverflowMenu"}}},"chat_v1_GoogleAppsCardV1OpenLink":{"description":"Represents an `onClick` event that opens a hyperlink. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"onClose":{"description":"Whether the client forgets about a link after opening it, or observes it until the window closes. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","enum":["NOTHING","RELOAD"],"type":"string"},"openAs":{"description":"How to open a link. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):","enum":["FULL_SIZE","OVERLAY"],"type":"string"},"url":{"description":"The URL to open. HTTP URLs are converted to HTTPS.","type":"string"}}},"chat_v1_GoogleAppsCardV1OverflowMenu":{"description":"A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"items":{"description":"Required. The list of menu options.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OverflowMenuItem"}}}},"chat_v1_GoogleAppsCardV1OverflowMenuItem":{"description":"An option that users can invoke in an overflow menu. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"disabled":{"description":"Whether the menu option is disabled. Defaults to false.","type":"boolean"},"onClick":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1OnClick"},"startIcon":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Icon"},"text":{"description":"Required. The text that identifies or describes the item to users.","type":"string"}}},"chat_v1_GoogleAppsCardV1PlatformDataSource":{"description":"For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"commonDataSource":{"description":"A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.","enum":["UNKNOWN","USER"],"type":"string"},"hostAppDataSource":{"$ref":"#/components/schemas/chat_v1_HostAppDataSourceMarkup"}}},"chat_v1_GoogleAppsCardV1Section":{"description":"A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"collapseControl":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1CollapseControl"},"collapsible":{"description":"Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.","type":"boolean"},"header":{"description":"Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"id":{"description":"A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"string"},"uncollapsibleWidgetsCount":{"description":"The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.","format":"int32","type":"integer"},"widgets":{"description":"All the widgets in the section. Must contain at least one widget.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Widget"}}}},"chat_v1_GoogleAppsCardV1SelectionInput":{"description":"A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"dataSourceConfigs":{"description":"Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DataSourceConfig"}},"externalDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"hintText":{"description":"Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"string"},"items":{"description":"An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionItem"}},"label":{"description":"The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be \"Urgency\" or \"Select urgency\".","type":"string"},"multiSelectMaxSelectedItems":{"description":"For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.","format":"int32","type":"integer"},"multiSelectMinQueryLength":{"description":"For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.","format":"int32","type":"integer"},"name":{"description":"Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"platformDataSource":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1PlatformDataSource"},"type":{"description":"The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.","enum":["CHECK_BOX","RADIO_BUTTON","SWITCH","DROPDOWN","MULTI_SELECT"],"type":"string"}}},"chat_v1_GoogleAppsCardV1SelectionItem":{"description":"An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"bottomText":{"description":"For multiselect menus, a text description or label that's displayed below the item's `text` field.","type":"string"},"selected":{"description":"Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.","type":"boolean"},"startIconUri":{"type":"string"},"text":{"description":"The text that identifies or describes the item to users.","type":"string"},"value":{"description":"The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"}}},"chat_v1_GoogleAppsCardV1SuggestionItem":{"description":"One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"text":{"description":"The value of a suggested input to a text input field. This is equivalent to what users enter themselves.","type":"string"}}},"chat_v1_GoogleAppsCardV1Suggestions":{"description":"Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"items":{"description":"A list of suggestions used for autocomplete recommendations in text input fields.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SuggestionItem"}}}},"chat_v1_GoogleAppsCardV1SwitchControl":{"description":"Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget.","type":"object","properties":{"controlType":{"description":"How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","enum":["SWITCH","CHECKBOX","CHECK_BOX"],"type":"string"},"name":{"description":"The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"selected":{"description":"When `true`, the switch is selected.","type":"boolean"},"value":{"description":"The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"}}},"chat_v1_GoogleAppsCardV1TextInput":{"description":"A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"autoCompleteAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"hintText":{"description":"Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.","type":"string"},"hostAppDataSource":{"$ref":"#/components/schemas/chat_v1_HostAppDataSourceMarkup"},"initialSuggestions":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Suggestions"},"label":{"description":"The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.","type":"string"},"name":{"description":"The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"},"onChangeAction":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Action"},"placeholderText":{"description":"Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"string"},"type":{"description":"How a text input field appears in the user interface. For example, whether the field is single or multi-line.","enum":["SINGLE_LINE","MULTIPLE_LINE"],"type":"string"},"validation":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Validation"},"value":{"description":"The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).","type":"string"}}},"chat_v1_GoogleAppsCardV1TextParagraph":{"description":"A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"maxLines":{"description":"The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.","format":"int32","type":"integer"},"text":{"description":"The text that's shown in the widget.","type":"string"},"textSyntax":{"description":"The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):","enum":["TEXT_SYNTAX_UNSPECIFIED","HTML","MARKDOWN"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Trigger":{"description":"Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"actionRuleId":{"description":"The unique identifier of the ActionRule.","type":"string"}}},"chat_v1_GoogleAppsCardV1UpdateVisibilityAction":{"description":"Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"object","properties":{"visibility":{"description":"The new visibility.","enum":["VISIBILITY_UNSPECIFIED","VISIBLE","HIDDEN"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Validation":{"description":"Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","type":"object","properties":{"characterLimit":{"description":"Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","format":"int32","type":"integer"},"inputType":{"description":"Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):","enum":["INPUT_TYPE_UNSPECIFIED","TEXT","INTEGER","FLOAT","EMAIL","EMOJI_PICKER"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Widget":{"description":"Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types.","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"},"carousel":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Carousel"},"chipList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ChipList"},"columns":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Columns"},"dateTimePicker":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DateTimePicker"},"decoratedText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DecoratedText"},"divider":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Divider"},"eventActions":{"description":"Specifies the event actions that can be performed on the widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1EventAction"}},"grid":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Grid"},"horizontalAlignment":{"description":"Specifies whether widgets align to the left, right, or center of a column.","enum":["HORIZONTAL_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"id":{"description":"A unique ID assigned to the widget that's used to identify the widget to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","type":"string"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Image"},"selectionInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionInput"},"textInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextInput"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"},"visibility":{"description":"Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.","enum":["VISIBILITY_UNSPECIFIED","VISIBLE","HIDDEN"],"type":"string"}}},"chat_v1_GoogleAppsCardV1Widgets":{"description":"The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)","type":"object","properties":{"buttonList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ButtonList"},"chipList":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1ChipList"},"dateTimePicker":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DateTimePicker"},"decoratedText":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1DecoratedText"},"image":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1Image"},"selectionInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionInput"},"textInput":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextInput"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1TextParagraph"}}},"chat_v1_GoogleChatV1Section":{"description":"Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`.","type":"object","properties":{"displayName":{"description":"Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`.","type":"string"},"name":{"description":"Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`","type":"string"},"sortOrder":{"description":"Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value.","format":"int32","type":"integer"},"type":{"description":"Required. The type of the section.","enum":["SECTION_TYPE_UNSPECIFIED","CUSTOM_SECTION","DEFAULT_DIRECT_MESSAGES","DEFAULT_SPACES","DEFAULT_APPS"],"type":"string"}}},"chat_v1_Group":{"description":"A Google Group in Google Chat.","type":"object","properties":{"name":{"description":"Resource name for a Google Group. Represents a [group](https://cloud.google.com/identity/docs/reference/rest/v1/groups) in Cloud Identity Groups API. Format: groups/{group}","type":"string"}}},"chat_v1_HostAppDataSourceMarkup":{"description":"A data source from a Google Workspace application. The data source populates available items for a widget.","type":"object","properties":{"chatDataSource":{"$ref":"#/components/schemas/chat_v1_ChatClientDataSourceMarkup"},"workflowDataSource":{"$ref":"#/components/schemas/chat_v1_WorkflowDataSourceMarkup"}}},"chat_v1_Image":{"description":"An image that's specified by a URL and can have an `onclick` action.","type":"object","properties":{"aspectRatio":{"description":"The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.","format":"double","type":"number"},"imageUrl":{"description":"The URL of the image.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"}}},"chat_v1_ImageButton":{"description":"An image button with an `onclick` action.","type":"object","properties":{"icon":{"description":"The icon specified by an `enum` that indices to an icon provided by Chat API.","enum":["ICON_UNSPECIFIED","AIRPLANE","BOOKMARK","BUS","CAR","CLOCK","CONFIRMATION_NUMBER_ICON","DOLLAR","DESCRIPTION","EMAIL","EVENT_PERFORMER","EVENT_SEAT","FLIGHT_ARRIVAL","FLIGHT_DEPARTURE","HOTEL","HOTEL_ROOM_TYPE","INVITE","MAP_PIN","MEMBERSHIP","MULTIPLE_PEOPLE","OFFER","PERSON","PHONE","RESTAURANT_ICON","SHOPPING_CART","STAR","STORE","TICKET","TRAIN","VIDEO_CAMERA","VIDEO_PLAY"],"type":"string"},"iconUrl":{"description":"The icon specified by a URL.","type":"string"},"name":{"description":"The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"}}},"chat_v1_Inputs":{"description":"Types of data that users can [input on cards or dialogs](https://developers.google.com/chat/ui/read-form-data). The input type depends on the type of values that the widget accepts.","type":"object","properties":{"dateInput":{"$ref":"#/components/schemas/chat_v1_DateInput"},"dateTimeInput":{"$ref":"#/components/schemas/chat_v1_DateTimeInput"},"stringInputs":{"$ref":"#/components/schemas/chat_v1_StringInputs"},"timeInput":{"$ref":"#/components/schemas/chat_v1_TimeInput"}}},"chat_v1_KeyValue":{"description":"A UI element contains a key (label) and a value (content). This element can also contain some actions such as `onclick` button.","type":"object","properties":{"bottomLabel":{"description":"The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"button":{"$ref":"#/components/schemas/chat_v1_Button"},"content":{"description":"The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"contentMultiline":{"description":"If the content should be multiline.","type":"boolean"},"icon":{"description":"An enum value that's replaced by the Chat API with the corresponding icon image.","enum":["ICON_UNSPECIFIED","AIRPLANE","BOOKMARK","BUS","CAR","CLOCK","CONFIRMATION_NUMBER_ICON","DOLLAR","DESCRIPTION","EMAIL","EVENT_PERFORMER","EVENT_SEAT","FLIGHT_ARRIVAL","FLIGHT_DEPARTURE","HOTEL","HOTEL_ROOM_TYPE","INVITE","MAP_PIN","MEMBERSHIP","MULTIPLE_PEOPLE","OFFER","PERSON","PHONE","RESTAURANT_ICON","SHOPPING_CART","STAR","STORE","TICKET","TRAIN","VIDEO_CAMERA","VIDEO_PLAY"],"type":"string"},"iconUrl":{"description":"The icon specified by a URL.","type":"string"},"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"},"topLabel":{"description":"The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"}}},"chat_v1_ListCustomEmojisResponse":{"description":"A response to list custom emojis.","type":"object","properties":{"customEmojis":{"description":"Unordered list. List of custom emojis.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_CustomEmoji"}},"nextPageToken":{"description":"A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListMembershipsResponse":{"description":"Response to list memberships of the space.","type":"object","properties":{"memberships":{"description":"Unordered list. List of memberships in the requested (or first) page.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Membership"}},"nextPageToken":{"description":"A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListMessagePinsResponse":{"description":"Response message for listing message pins.","type":"object","properties":{"messagePins":{"description":"The pinned messages from the specified space.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessagePin"}},"nextPageToken":{"description":"You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListMessagesResponse":{"description":"Response message for listing messages.","type":"object","properties":{"messages":{"description":"List of messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Message"}},"nextPageToken":{"description":"You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"}}},"chat_v1_ListReactionsResponse":{"description":"Response to a list reactions request.","type":"object","properties":{"nextPageToken":{"description":"Continuation token to retrieve the next page of results. It's empty for the last page of results.","type":"string"},"reactions":{"description":"List of reactions in the requested (or first) page.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Reaction"}}}},"chat_v1_ListSectionItemsResponse":{"description":"Response message for listing section items.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"sectionItems":{"description":"The section items from the specified section.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SectionItem"}}}},"chat_v1_ListSectionsResponse":{"description":"Response message for listing sections.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"sections":{"description":"The sections from the specified user.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}}},"chat_v1_ListSpaceEventsResponse":{"description":"Response message for listing space events.","type":"object","properties":{"nextPageToken":{"description":"Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages.","type":"string"},"spaceEvents":{"description":"Results are returned in chronological order (oldest event first). Note: The `permissionSettings` field is not returned in the Space object for list requests.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SpaceEvent"}}}},"chat_v1_ListSpacesResponse":{"description":"The response for a list spaces request.","type":"object","properties":{"nextPageToken":{"description":"You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.","type":"string"},"spaces":{"description":"List of spaces in the requested (or first) page. Note: The `permissionSettings` field is not returned in the Space object for list requests.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Space"}}}},"chat_v1_MarkAsActiveRequest":{"description":"Request message for the `MarkAsActive` method.","type":"object","properties":{"expireTime":{"description":"The absolute timestamp when the ACTIVE state expires.","format":"google-datetime","type":"string"},"ttl":{"description":"The duration from the current time until the ACTIVE state expires. Using a short TTL can effectively reset the user's state to be based on activity after this brief duration.","format":"google-duration","type":"string"}}},"chat_v1_MarkAsAwayRequest":{"description":"Request message for the `MarkAsAway` method.","type":"object"},"chat_v1_MarkAsDoNotDisturbRequest":{"description":"Request message for the `MarkAsDoNotDisturb` method.","type":"object","properties":{"expireTime":{"description":"The absolute timestamp when the DND state expires.","format":"google-datetime","type":"string"},"ttl":{"description":"The duration from the current time until the DND state expires.","format":"google-duration","type":"string"}}},"chat_v1_MatchedUrl":{"description":"A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links).","type":"object","properties":{"url":{"description":"Output only. The URL that was matched.","readOnly":true,"type":"string"}}},"chat_v1_Media":{"description":"Media resource.","type":"object","properties":{"resourceName":{"description":"Name of the media resource.","type":"string"}}},"chat_v1_MeetSpaceLinkData":{"description":"Data for Meet space links.","type":"object","properties":{"huddleStatus":{"description":"Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.","readOnly":true,"enum":["HUDDLE_STATUS_UNSPECIFIED","STARTED","ENDED","MISSED"],"type":"string"},"meetingCode":{"description":"Meeting code of the linked Meet space.","type":"string"},"type":{"description":"Indicates the type of the Meet space.","enum":["TYPE_UNSPECIFIED","MEETING","HUDDLE"],"type":"string"}}},"chat_v1_Membership":{"description":"Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.","type":"object","properties":{"affiliation":{"description":"Output only. A user's relationship to the Workspace organization that owns the space. In spaces owned by consumer accounts, the affiliation of all members is `EXTERNAL`.","readOnly":true,"enum":["AFFILIATION_UNSPECIFIED","INTERNAL","EXTERNAL","MANAGED_EXTERNAL"],"type":"string"},"createTime":{"description":"Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.","format":"google-datetime","type":"string"},"deleteTime":{"description":"Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.","format":"google-datetime","type":"string"},"groupMember":{"$ref":"#/components/schemas/chat_v1_Group"},"member":{"$ref":"#/components/schemas/chat_v1_User"},"name":{"description":"Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`","type":"string"},"role":{"description":"Optional. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership`.","enum":["MEMBERSHIP_ROLE_UNSPECIFIED","ROLE_MEMBER","ROLE_MANAGER","ROLE_ASSISTANT_MANAGER"],"type":"string"},"state":{"description":"Output only. State of the membership.","readOnly":true,"enum":["MEMBERSHIP_STATE_UNSPECIFIED","JOINED","INVITED","NOT_A_MEMBER"],"type":"string"}}},"chat_v1_MembershipBatchCreatedEventData":{"description":"Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`","type":"object","properties":{"memberships":{"description":"A list of new memberships.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MembershipCreatedEventData"}}}},"chat_v1_MembershipBatchDeletedEventData":{"description":"Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`","type":"object","properties":{"memberships":{"description":"A list of deleted memberships.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MembershipDeletedEventData"}}}},"chat_v1_MembershipBatchUpdatedEventData":{"description":"Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`","type":"object","properties":{"memberships":{"description":"A list of updated memberships.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MembershipUpdatedEventData"}}}},"chat_v1_MembershipCount":{"description":"Represents the count of memberships of a space, grouped into categories.","type":"object","properties":{"joinedDirectHumanUserCount":{"description":"Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.","format":"int32","readOnly":true,"type":"integer"},"joinedGroupCount":{"description":"Output only. Count of all groups that have directly joined the space.","format":"int32","readOnly":true,"type":"integer"}}},"chat_v1_MembershipCreatedEventData":{"description":"Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`.","type":"object","properties":{"membership":{"$ref":"#/components/schemas/chat_v1_Membership"}}},"chat_v1_MembershipDeletedEventData":{"description":"Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`","type":"object","properties":{"membership":{"$ref":"#/components/schemas/chat_v1_Membership"}}},"chat_v1_MembershipUpdatedEventData":{"description":"Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`","type":"object","properties":{"membership":{"$ref":"#/components/schemas/chat_v1_Membership"}}},"chat_v1_Message":{"description":"A message in a Google Chat space.","type":"object","properties":{"accessoryWidgets":{"description":"Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).","type":"array","items":{"$ref":"#/components/schemas/chat_v1_AccessoryWidget"}},"actionResponse":{"$ref":"#/components/schemas/chat_v1_ActionResponse"},"annotations":{"description":"Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_Annotation"}},"argumentText":{"description":"Output only. Plain-text body of the message with all Chat app mentions stripped out.","readOnly":true,"type":"string"},"attachedGifs":{"description":"Output only. GIF images that are attached to the message.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_AttachedGif"}},"attachment":{"description":"Optional. User-uploaded attachment.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Attachment"}},"cards":{"description":"Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Card"}},"cardsV2":{"description":"Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)","type":"array","items":{"$ref":"#/components/schemas/chat_v1_CardWithId"}},"clientAssignedMessageId":{"description":"Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"createTime":{"description":"Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.","format":"google-datetime","type":"string"},"deleteTime":{"description":"Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.","format":"google-datetime","readOnly":true,"type":"string"},"deletionMetadata":{"$ref":"#/components/schemas/chat_v1_DeletionMetadata"},"emojiReactionSummaries":{"description":"Output only. The list of emoji reaction summaries on the message.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_EmojiReactionSummary"}},"fallbackText":{"description":"Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.","type":"string"},"formattedText":{"description":"Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)","readOnly":true,"type":"string"},"lastUpdateTime":{"description":"Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.","format":"google-datetime","readOnly":true,"type":"string"},"markupSyntax":{"description":"Optional. Specifies how the server interprets the message `text` field content.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"matchedUrl":{"$ref":"#/components/schemas/chat_v1_MatchedUrl"},"name":{"description":"Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).","type":"string"},"privateMessageViewer":{"$ref":"#/components/schemas/chat_v1_User"},"quotedMessageMetadata":{"$ref":"#/components/schemas/chat_v1_QuotedMessageMetadata"},"sender":{"$ref":"#/components/schemas/chat_v1_User"},"silent":{"description":"Output only. Whether this is a silent message. Silent messages are messages where Chat suppresses push notifications for recipients.","readOnly":true,"type":"boolean"},"slashCommand":{"$ref":"#/components/schemas/chat_v1_SlashCommand"},"space":{"$ref":"#/components/schemas/chat_v1_Space"},"text":{"description":"Optional. Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a message](https://developers.google.com/workspace/chat/create-messages).","type":"string"},"thread":{"$ref":"#/components/schemas/chat_v1_Thread"},"threadReply":{"description":"Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`.","readOnly":true,"type":"boolean"}}},"chat_v1_MessageBatchCreatedEventData":{"description":"Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`","type":"object","properties":{"messages":{"description":"A list of new messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessageCreatedEventData"}}}},"chat_v1_MessageBatchDeletedEventData":{"description":"Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`","type":"object","properties":{"messages":{"description":"A list of deleted messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessageDeletedEventData"}}}},"chat_v1_MessageBatchUpdatedEventData":{"description":"Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`","type":"object","properties":{"messages":{"description":"A list of updated messages.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_MessageUpdatedEventData"}}}},"chat_v1_MessageCreatedEventData":{"description":"Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"}}},"chat_v1_MessageDeletedEventData":{"description":"Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"}}},"chat_v1_MessagePin":{"description":"A pin on a Chat message. For more information see [Pin a message](https://support.google.com/chat?p=chat-board-hc).","type":"object","properties":{"message":{"description":"Required. Immutable. The resource name of the message that is pinned. Format: `spaces/{space}/messages/{message}`","type":"string"},"name":{"description":"Identifier. The resource name of the message pin. Format: `spaces/{space}/messagePins/{message_pin}` The resource ID component matches the resource ID component of the message. For example, a message with `spaces/AAA/messages/bbb.ccc` corresponds to the message pin with the resource name `spaces/AAA/messagePins/bbb.ccc`.","type":"string"}}},"chat_v1_MessageUpdatedEventData":{"description":"Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"}}},"chat_v1_MoveSectionItemRequest":{"description":"Request message for moving a section item across sections.","type":"object","properties":{"targetSection":{"description":"Required. The resource name of the section to move the section item to. Format: `users/{user}/sections/{section}`","type":"string"}}},"chat_v1_MoveSectionItemResponse":{"description":"Response message for moving a section item.","type":"object","properties":{"sectionItem":{"$ref":"#/components/schemas/chat_v1_SectionItem"}}},"chat_v1_OnClick":{"description":"An `onclick` action (for example, open a link).","type":"object","properties":{"action":{"$ref":"#/components/schemas/chat_v1_FormAction"},"openLink":{"$ref":"#/components/schemas/chat_v1_OpenLink"}}},"chat_v1_OpenLink":{"description":"A link that opens a new window.","type":"object","properties":{"url":{"description":"The URL to open.","type":"string"}}},"chat_v1_PermissionSetting":{"description":"Represents a space permission setting.","type":"object","properties":{"assistantManagersAllowed":{"description":"Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.","type":"boolean"},"managersAllowed":{"description":"Optional. Whether space owners (`ROLE_MANAGER`) have this permission.","type":"boolean"},"membersAllowed":{"description":"Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.","type":"boolean"}}},"chat_v1_PermissionSettings":{"description":"[Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request.","type":"object","properties":{"manageApps":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"manageMembersAndGroups":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"manageWebhooks":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"modifySpaceDetails":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"postMessages":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"replyMessages":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"toggleHistory":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"useAtMentionAll":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"},"viewSpaceMembership":{"$ref":"#/components/schemas/chat_v1_PermissionSetting"}}},"chat_v1_PositionSectionRequest":{"description":"Request message for positioning a section.","type":"object","properties":{"relativePosition":{"description":"Optional. The relative position of the section in the list of sections.","enum":["POSITION_UNSPECIFIED","START","END"],"type":"string"},"sortOrder":{"description":"Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.","format":"int32","type":"integer"}}},"chat_v1_PositionSectionResponse":{"description":"Response message for positioning a section.","type":"object","properties":{"section":{"$ref":"#/components/schemas/chat_v1_GoogleChatV1Section"}}},"chat_v1_Principal":{"description":"A principal representing an entity granted access.","type":"object","properties":{"audience":{"$ref":"#/components/schemas/chat_v1_Audience"}}},"chat_v1_QuotedMessageMetadata":{"description":"Information about a message that another message quotes. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see [Quote another message](https://developers.google.com/workspace/chat/create-messages#quote-a-message).","type":"object","properties":{"forwardedMetadata":{"$ref":"#/components/schemas/chat_v1_ForwardedMetadata"},"lastUpdateTime":{"description":"Required. The timestamp when the quoted message was created or when the quoted message was last updated. If the message was edited, use this field, `last_update_time`. If the message was never edited, use `create_time`. If `last_update_time` doesn't match the latest version of the quoted message, the request fails.","format":"google-datetime","type":"string"},"name":{"description":"Required. Resource name of the message that is quoted. Format: `spaces/{space}/messages/{message}`","type":"string"},"quoteType":{"description":"Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility.","enum":["QUOTE_TYPE_UNSPECIFIED","REPLY","FORWARD"],"type":"string"},"quotedMessageSnapshot":{"$ref":"#/components/schemas/chat_v1_QuotedMessageSnapshot"}}},"chat_v1_QuotedMessageSnapshot":{"description":"Provides a snapshot of the content of the quoted message at the time of quoting or forwarding","type":"object","properties":{"annotations":{"description":"Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_Annotation"}},"attachments":{"description":"Output only. Attachments that were part of the quoted message. These are copies of the quoted message's attachment metadata. Populated only for FORWARD quote type.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_Attachment"}},"formattedText":{"description":"Output only. Contains the quoted message `text` with markups added to support rich formatting like hyperlinks,custom emojis, markup, etc. Populated only for FORWARD quote type.","readOnly":true,"type":"string"},"sender":{"description":"Output only. The quoted message's author name. Populated for both REPLY & FORWARD quote types.","readOnly":true,"type":"string"},"text":{"description":"Output only. Snapshot of the quoted message's text content.","readOnly":true,"type":"string"}}},"chat_v1_Reaction":{"description":"A reaction to a message.","type":"object","properties":{"emoji":{"$ref":"#/components/schemas/chat_v1_Emoji"},"name":{"description":"Identifier. The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`","type":"string"},"user":{"$ref":"#/components/schemas/chat_v1_User"}}},"chat_v1_ReactionBatchCreatedEventData":{"description":"Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`","type":"object","properties":{"reactions":{"description":"A list of new reactions.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_ReactionCreatedEventData"}}}},"chat_v1_ReactionBatchDeletedEventData":{"description":"Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`","type":"object","properties":{"reactions":{"description":"A list of deleted reactions.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_ReactionDeletedEventData"}}}},"chat_v1_ReactionCreatedEventData":{"description":"Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`","type":"object","properties":{"reaction":{"$ref":"#/components/schemas/chat_v1_Reaction"}}},"chat_v1_ReactionDeletedEventData":{"description":"Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted`","type":"object","properties":{"reaction":{"$ref":"#/components/schemas/chat_v1_Reaction"}}},"chat_v1_RichLinkMetadata":{"description":"A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.","type":"object","properties":{"calendarEventLinkData":{"$ref":"#/components/schemas/chat_v1_CalendarEventLinkData"},"chatSpaceLinkData":{"$ref":"#/components/schemas/chat_v1_ChatSpaceLinkData"},"driveLinkData":{"$ref":"#/components/schemas/chat_v1_DriveLinkData"},"meetSpaceLinkData":{"$ref":"#/components/schemas/chat_v1_MeetSpaceLinkData"},"richLinkType":{"description":"The rich link type.","enum":["RICH_LINK_TYPE_UNSPECIFIED","DRIVE_FILE","CHAT_SPACE","GMAIL_MESSAGE","MEET_SPACE","CALENDAR_EVENT"],"type":"string"},"uri":{"description":"The URI of this link.","type":"string"}}},"chat_v1_SearchMessageResult":{"description":"A single result item from a message search.","type":"object","properties":{"message":{"$ref":"#/components/schemas/chat_v1_Message"},"read":{"description":"Indicates if the matched message is read by the calling user. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`","type":"boolean"},"spaceMuteSetting":{"description":"The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not. Only returned if the request view is `SEARCH_MESSAGES_VIEW_FULL` and the calling credentials include the following [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`","enum":["MUTE_SETTING_UNSPECIFIED","UNMUTED","MUTED"],"type":"string"}}},"chat_v1_SearchMessagesRequest":{"description":"Request message for searching messages.","type":"object","properties":{"filter":{"description":"Required. A search query. The query can specify one or more search keywords, which are used to filter the results, You can also filter the results using the following message fields: - `create_time`: Accepts a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `<` and `>=`. - `sender.name`: The resource name of the sender (`users/{user}`). Only supports `=`. You can use the e-mail as an alias for `{user}`. For example, `users/example@gmail.com`, where `example@gmail.com` is the e-mail of the Google Chat user. - `space.name`: The resource name of the space where the message is posted. (`spaces/{space}`). Only supports `=`. If this filter is not set, the search is performed across all direct messages and spaces the user has access to as a space member. - `space.display_name`: Supports the operator `:` (has) and filters spaces based on a partial match of their display name. Results are limited to the top five space matches. For example, `space.display_name:Project` searches for messages in the top five spaces that contain the word \"Project\" in their display names. - `space.space_type`: The type of the space. Only supports `=`. For example, `space.space_type=\"DIRECT_MESSAGE\"` returns only messages from direct messages. The possible values are `DIRECT_MESSAGE`, `GROUP_CHAT`, and `SPACE`. - `attachment`: Supports the operator `:*` (has any) to check for the presence of attachments. If `attachment:*` is specified, only messages that have at least one attachment are returned. - `annotations.user_mentions.user.name`: The resource name of the mentioned user (`users/{user}`). Only supports `:` (has). For example: `annotations.user_mentions.user.name:\"users/1234567890\"` returns only messages that contain a mention to the specified user. Alternatively, the alias `me` can be used to filter for messages that mention the caller user, for example: `annotations.user_mentions.user.name:users/me`. You can also use the e-mail as an alias for `{user}`, for example, `users/example@gmail.com`. For advanced filtering, the following functions are also available: - `has_link()`: Returns only messages that have at least one hyperlink in the message text. - `is_unread()`: Filters out messages that have been read by the calling user. Using the `space.display_name` or the `space.space_type` filters requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` Using the `is_unread()` filter requires that the calling credentials include one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` Across different fields, only `AND` operators are supported. A valid example is `sender.name = \"users/1234567890\" AND is_unread()`. The word `AND` is optional and is implied if omitted. For example, `sender.name = \"users/1234567890\" is_unread()` is valid and is equivalent to the previous example. An invalid example is `sender.name = \"users/1234567890\" OR is_unread()` because `OR` is not supported between different fields. Among the same field: - `create_time` supports only `AND`, and can only be used to represent an interval, such as `create_time >= \"2022-01-01T00:00:00+00:00\" AND create_time < \"2023-01-01T00:00:00+00:00\"`. - `sender.name` supports only the `OR` operator, for example: `sender.name = \"users/1234567890\" OR sender.name = \"users/0987654321\"`. - `space.name` supports only the `OR` operator, for example: `space.name = \"spaces/ABCDEFGH\" OR space.name = \"spaces/QWERTYUI\"`. - `space.display_name` supports the operators `AND` and `OR`, but not a mix of both. For example: `space.display_name:Project AND space.display_name:Tasks` returns messages that are in spaces with display names containing both `Project` and `Tasks`, whereas `space.display_name:Project OR space.display_name:Tasks` returns messages that are in spaces with display names containing either `Project` or `Tasks` or both. - `space.space_type` supports only the `OR` operator, for example: `space.space_type = \"DIRECT_MESSAGE\" OR space.space_type = \"GROUP_CHAT\"`. - `annotations.user_mentions.user.name` supports the operators `AND` and `OR`, but not a mix of both. For example: `annotations.user_mentions.user.name:\"users/1234567890\" AND annotations.user_mentions.user.name:\"users/0987654321\"` returns only messages that mentions both users, whereas `annotations.user_mentions.user.name:\"users/1234567890\" OR annotations.user_mentions.user.name:\"users/0987654321\"` returns messages that mention either user or both. Parentheses are required to disambiguate operator precedence when combining `AND` and `OR` operators in the same query. For example: `(sender.name=\"users/me\" OR sender.name=\"users/123456\") AND is_unread()`. Otherwise, parentheses are optional. The following example queries are valid: ``` \"Pending reports\" AND create_time >= \"2023-01-01T00:00:00Z\" sender.name = \"users/example@gmail.com\" annotations.user_mentions.user.name:\"users/0987654321\" attachment:* AND space.name = \"spaces/ABCDEFGH\" tasks AND is_unread() AND sender.name = \"users/1234567890\" \"things to do\" \"urgent\" (sender.name = \"users/1234567890\") AND (create_time < \"2023-05-01T00:00:00Z\") tasks AND space.name = \"spaces/ABCDEFGH\" AND has_link() \"project one\" is_unread() space.display_name:Project tasks ``` The maximum query length is 1,000 characters. Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.","type":"string"},"markupSyntax":{"description":"Optional. Specifies the desired output syntax for the Chat message `formatted_text` field.","enum":["MARKUP_SYNTAX_UNSPECIFIED","MARKUP_SYNTAX_CHAT","MARKUP_SYNTAX_MARKDOWN"],"type":"string"},"orderBy":{"description":"Optional. How the results list is ordered. Supported attributes to order by are: - `create_time`: Sorts the results by the time of the message creation. Default value. - `relevance`: Sorts the results by relevance. [Developer Preview](https://developers.google.com/workspace/preview). The default ordering is `create_time desc`. Only a single order per query (`create_time` or `relevance`) is supported. Only descending order (`desc`) is supported, and it must be specified after the order attribute.","type":"string"},"pageSize":{"description":"Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 25 are returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.","format":"int32","type":"integer"},"pageToken":{"description":"Optional. A token, received from the previous search messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.","type":"string"},"view":{"description":"Optional. Specifies what kind of search results view to return. The default is `SEARCH_MESSAGES_VIEW_BASIC`.","enum":["SEARCH_MESSAGES_VIEW_UNSPECIFIED","SEARCH_MESSAGES_VIEW_BASIC","SEARCH_MESSAGES_VIEW_FULL"],"type":"string"}}},"chat_v1_SearchMessagesResponse":{"description":"Response message for searching messages.","type":"object","properties":{"nextPageToken":{"description":"A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.","type":"string"},"results":{"description":"The list of search results that matched the query.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SearchMessageResult"}}}},"chat_v1_SearchSpaceResult":{"description":"A single result item from a space search.","type":"object","properties":{"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_SearchSpacesResponse":{"description":"Response with a list of spaces corresponding to the search spaces request.","type":"object","properties":{"nextPageToken":{"description":"A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages. Only populated when `useAdminAccess` is set to `true`.","type":"string"},"results":{"description":"Output only. The list of search results that matched the query.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/chat_v1_SearchSpaceResult"}},"spaces":{"description":"Deprecated: Please use the new `results` field instead. A page of the requested spaces. This field will be populated only when `useAdminAccess` is set to `true` and deprecated in favor of the new `results` field.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Space"}},"totalSize":{"description":"The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate. Only populated when `useAdminAccess` is set to `true`.","format":"int32","type":"integer"}}},"chat_v1_Section":{"description":"A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).","type":"object","properties":{"header":{"description":"The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"string"},"widgets":{"description":"A section must contain at least one widget.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_WidgetMarkup"}}}},"chat_v1_SectionItem":{"description":"A user's defined section item. This is used to represent section items, such as spaces, grouped under a section.","type":"object","properties":{"name":{"description":"Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}`","type":"string"},"space":{"description":"Optional. The space resource name. Format: `spaces/{space}`","type":"string"}}},"chat_v1_SelectionItems":{"description":"List of widget autocomplete results.","type":"object","properties":{"items":{"description":"An array of the SelectionItem objects.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_GoogleAppsCardV1SelectionItem"}}}},"chat_v1_SetUpSpaceRequest":{"description":"Request to create a space and add specified users to it.","type":"object","properties":{"memberships":{"description":"Optional. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 49 memberships (in addition to the caller). For human membership, the `Membership.member` field must contain a `user` with `name` populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the `user.name` can be `users/example@gmail.com`. To invite Gmail users or users from external Google Workspace domains, user's email must be used for `{user}`. For Google group membership, the `Membership.group_member` field must contain a `group` with `name` populated (format `groups/{group}`). You can only add Google groups when setting `Space.spaceType` to `SPACE`. Optional when setting `Space.spaceType` to `SPACE`. Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships. Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Membership"}},"requestId":{"description":"Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.","type":"string"},"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_SlashCommand":{"description":"Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat.","type":"object","properties":{"commandId":{"description":"The ID of the slash command.","format":"int64","type":"string"}}},"chat_v1_SlashCommandMetadata":{"description":"Annotation metadata for slash commands (/).","type":"object","properties":{"bot":{"$ref":"#/components/schemas/chat_v1_User"},"commandId":{"description":"The command ID of the invoked slash command.","format":"int64","type":"string"},"commandName":{"description":"The name of the invoked slash command.","type":"string"},"triggersDialog":{"description":"Indicates whether the slash command is for a dialog.","type":"boolean"},"type":{"description":"The type of slash command.","enum":["TYPE_UNSPECIFIED","ADD","INVOKE"],"type":"string"}}},"chat_v1_Space":{"description":"A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.","type":"object","properties":{"accessSettings":{"$ref":"#/components/schemas/chat_v1_AccessSettings"},"adminInstalled":{"description":"Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.","readOnly":true,"type":"boolean"},"createTime":{"description":"Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.","format":"google-datetime","type":"string"},"customer":{"description":"Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.","type":"string"},"displayName":{"description":"Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.","type":"string"},"externalUserAllowed":{"description":"Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.","type":"boolean"},"importMode":{"description":"Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).","type":"boolean"},"importModeExpireTime":{"description":"Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode.","format":"google-datetime","readOnly":true,"type":"string"},"lastActiveTime":{"description":"Output only. Timestamp of the last message in the space.","format":"google-datetime","readOnly":true,"type":"string"},"membershipCount":{"$ref":"#/components/schemas/chat_v1_MembershipCount"},"name":{"description":"Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.","type":"string"},"permissionSettings":{"$ref":"#/components/schemas/chat_v1_PermissionSettings"},"predefinedPermissionSettings":{"description":"Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)","enum":["PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED","COLLABORATION_SPACE","ANNOUNCEMENT_SPACE"],"type":"string"},"singleUserBotDm":{"description":"Optional. Whether the space is a DM between a Chat app and a single human.","type":"boolean"},"spaceDetails":{"$ref":"#/components/schemas/chat_v1_SpaceDetails"},"spaceHistoryState":{"description":"Optional. The message history state for messages and threads in this space.","enum":["HISTORY_STATE_UNSPECIFIED","HISTORY_OFF","HISTORY_ON"],"type":"string"},"spaceThreadingState":{"description":"Output only. The threading state in the Chat space.","readOnly":true,"enum":["SPACE_THREADING_STATE_UNSPECIFIED","THREADED_MESSAGES","GROUPED_MESSAGES","UNTHREADED_MESSAGES"],"type":"string"},"spaceType":{"description":"Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.","enum":["SPACE_TYPE_UNSPECIFIED","SPACE","GROUP_CHAT","DIRECT_MESSAGE"],"type":"string"},"spaceUri":{"description":"Output only. The URI for a user to access the space.","readOnly":true,"type":"string"},"threaded":{"description":"Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.","readOnly":true,"type":"boolean"},"type":{"description":"Output only. Deprecated: Use `space_type` instead. The type of a space.","readOnly":true,"enum":["TYPE_UNSPECIFIED","ROOM","DM"],"type":"string"}}},"chat_v1_SpaceBatchUpdatedEventData":{"description":"Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`","type":"object","properties":{"spaces":{"description":"A list of updated spaces.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_SpaceUpdatedEventData"}}}},"chat_v1_SpaceDataSource":{"description":"A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat):","type":"object","properties":{"defaultToCurrentSpace":{"description":"If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.","type":"boolean"}}},"chat_v1_SpaceDetails":{"description":"Details about the space including description and rules.","type":"object","properties":{"description":{"description":"Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters.","type":"string"},"guidelines":{"description":"Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters.","type":"string"}}},"chat_v1_SpaceEvent":{"description":"An event that represents a change or activity in a Google Chat space. To learn more, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).","type":"object","properties":{"eventTime":{"description":"Time when the event occurred.","format":"google-datetime","type":"string"},"eventType":{"description":"Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`","type":"string"},"membershipBatchCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipBatchCreatedEventData"},"membershipBatchDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipBatchDeletedEventData"},"membershipBatchUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipBatchUpdatedEventData"},"membershipCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipCreatedEventData"},"membershipDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipDeletedEventData"},"membershipUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MembershipUpdatedEventData"},"messageBatchCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageBatchCreatedEventData"},"messageBatchDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MessageBatchDeletedEventData"},"messageBatchUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageBatchUpdatedEventData"},"messageCreatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageCreatedEventData"},"messageDeletedEventData":{"$ref":"#/components/schemas/chat_v1_MessageDeletedEventData"},"messageUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_MessageUpdatedEventData"},"name":{"description":"Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`","type":"string"},"reactionBatchCreatedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionBatchCreatedEventData"},"reactionBatchDeletedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionBatchDeletedEventData"},"reactionCreatedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionCreatedEventData"},"reactionDeletedEventData":{"$ref":"#/components/schemas/chat_v1_ReactionDeletedEventData"},"spaceBatchUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_SpaceBatchUpdatedEventData"},"spaceUpdatedEventData":{"$ref":"#/components/schemas/chat_v1_SpaceUpdatedEventData"}}},"chat_v1_SpaceNotificationSetting":{"description":"The notification setting of a user in a space.","type":"object","properties":{"muteSetting":{"description":"The space notification mute setting.","enum":["MUTE_SETTING_UNSPECIFIED","UNMUTED","MUTED"],"type":"string"},"name":{"description":"Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.","type":"string"},"notificationSetting":{"description":"The notification setting.","enum":["NOTIFICATION_SETTING_UNSPECIFIED","ALL","MAIN_CONVERSATIONS","FOR_YOU","OFF"],"type":"string"}}},"chat_v1_SpaceReadState":{"description":"A user's read state within a space, used to identify read and unread messages.","type":"object","properties":{"lastReadTime":{"description":"Optional. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.","format":"google-datetime","type":"string"},"name":{"description":"Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`","type":"string"}}},"chat_v1_SpaceUpdatedEventData":{"description":"Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated`","type":"object","properties":{"space":{"$ref":"#/components/schemas/chat_v1_Space"}}},"chat_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"chat_v1_StringInputs":{"description":"Input parameter for regular widgets. For single-valued widgets, it is a single value list. For multi-valued widgets, such as checkbox, all the values are presented.","type":"object","properties":{"value":{"description":"An list of strings entered by the user.","type":"array","items":{"type":"string"}}}},"chat_v1_TextButton":{"description":"A button with text and `onclick` action.","type":"object","properties":{"onClick":{"$ref":"#/components/schemas/chat_v1_OnClick"},"text":{"description":"The text of the button.","type":"string"}}},"chat_v1_TextParagraph":{"description":"A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).","type":"object","properties":{"text":{"type":"string"}}},"chat_v1_Thread":{"description":"A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found.","type":"object","properties":{"name":{"description":"Identifier. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`","type":"string"},"threadKey":{"description":"Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead.","type":"string"}}},"chat_v1_ThreadReadState":{"description":"A user's read state within a thread, used to identify read and unread messages.","type":"object","properties":{"lastReadTime":{"description":"The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.","format":"google-datetime","type":"string"},"name":{"description":"Resource name of the thread read state. Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`","type":"string"}}},"chat_v1_TimeInput":{"description":"Time input values.","type":"object","properties":{"hours":{"description":"The hour on a 24-hour clock.","format":"int32","type":"integer"},"minutes":{"description":"The number of minutes past the hour. Valid values are 0 to 59.","format":"int32","type":"integer"}}},"chat_v1_TimeZone":{"description":"The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).","type":"object","properties":{"id":{"description":"The [IANA TZ](https://www.iana.org/time-zones) time zone database code, such as \"America/Toronto\".","type":"string"},"offset":{"description":"The user timezone offset, in milliseconds, from Coordinated Universal Time (UTC).","format":"int32","type":"integer"}}},"chat_v1_UpdatedWidget":{"description":"For `selectionInput` widgets, returns autocomplete suggestions for a multiselect menu.","type":"object","properties":{"suggestions":{"$ref":"#/components/schemas/chat_v1_SelectionItems"},"widget":{"description":"The ID of the updated widget. The ID must match the one for the widget that triggered the update request.","type":"string"}}},"chat_v1_UploadAttachmentRequest":{"description":"Request to upload an attachment.","type":"object","properties":{"filename":{"description":"Required. The filename of the attachment, including the file extension.","type":"string"}}},"chat_v1_UploadAttachmentResponse":{"description":"Response of uploading an attachment.","type":"object","properties":{"attachmentDataRef":{"$ref":"#/components/schemas/chat_v1_AttachmentDataRef"}}},"chat_v1_User":{"description":"If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource (such as in the Messages and Memberships APIs) only populates the `name` and `type` fields for both internal and external users, unless they are members of the space or have prior affinity with the calling user.","type":"object","properties":{"avatarUrl":{"description":"Output only. The user's avatar image URL. When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user.","readOnly":true,"type":"string"},"displayName":{"description":"Output only. The user's display name. Populated for both app authentication and user authentication. This field is always populated for requests made with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user.","readOnly":true,"type":"string"},"domainId":{"description":"Unique identifier of the user's Google Workspace domain.","type":"string"},"email":{"description":"Output only. The user's email address. When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user.","readOnly":true,"type":"string"},"isAnonymous":{"description":"Output only. When `true`, the user is deleted or their profile is not visible, such as when a user is mentioned in a space without being a member and without prior affinity with the calling user.","readOnly":true,"type":"boolean"},"name":{"description":"Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API.","type":"string"},"type":{"description":"User type.","enum":["TYPE_UNSPECIFIED","HUMAN","BOT"],"type":"string"}}},"chat_v1_UserMentionMetadata":{"description":"Annotation metadata for user mentions (@).","type":"object","properties":{"type":{"description":"The type of user mention.","enum":["TYPE_UNSPECIFIED","ADD","MENTION"],"type":"string"},"user":{"$ref":"#/components/schemas/chat_v1_User"}}},"chat_v1_WidgetMarkup":{"description":"A widget is a UI element that presents text and images.","type":"object","properties":{"buttons":{"description":"A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.","type":"array","items":{"$ref":"#/components/schemas/chat_v1_Button"}},"image":{"$ref":"#/components/schemas/chat_v1_Image"},"keyValue":{"$ref":"#/components/schemas/chat_v1_KeyValue"},"textParagraph":{"$ref":"#/components/schemas/chat_v1_TextParagraph"}}},"chat_v1_WorkflowDataSourceMarkup":{"description":"* Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google.","type":"object","properties":{"includeVariables":{"description":"Whether to include variables from the previous step in the data source.","type":"boolean"},"type":{"description":"The type of data source.","enum":["UNKNOWN","USER","SPACE","USER_WITH_FREE_FORM"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/chat.spaces":"Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat","https://www.googleapis.com/auth/chat.memberships":"See, add, update, and remove members from conversations and spaces in Google Chat","https://www.googleapis.com/auth/chat.messages":"See, compose, send, update, and delete messages, their content, and attached cards; add, see, and delete reactions to messages.","https://www.googleapis.com/auth/chat.customemojis":"View, create, and delete custom emoji in Google Chat","https://www.googleapis.com/auth/chat.delete":"Delete conversations and spaces and remove access to associated files in Google Chat","https://www.googleapis.com/auth/chat.users.readstate":"View and modify last read time for Google Chat conversations","https://www.googleapis.com/auth/chat.users.spacesettings":"Read and update your space settings","https://www.googleapis.com/auth/chat.users.sections":"View, create, update, and delete your sections in Google Chat; move and list your section items in Google Chat","https://www.googleapis.com/auth/chat.users.availability":"See and change your availability status in Google Chat.","https://www.googleapis.com/auth/chat.customemojis.readonly":"View custom emoji in Google Chat","https://www.googleapis.com/auth/chat.spaces.readonly":"View chat and spaces in Google Chat","https://www.googleapis.com/auth/chat.messages.readonly":"See messages as well as their reactions and message content in Google Chat","https://www.googleapis.com/auth/chat.memberships.readonly":"View members in Google Chat conversations."}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/chat.spaces","https://www.googleapis.com/auth/chat.memberships","https://www.googleapis.com/auth/chat.messages","https://www.googleapis.com/auth/chat.customemojis","https://www.googleapis.com/auth/chat.delete","https://www.googleapis.com/auth/chat.users.readstate","https://www.googleapis.com/auth/chat.users.spacesettings","https://www.googleapis.com/auth/chat.users.sections","https://www.googleapis.com/auth/chat.users.availability"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/chat/v1/rest","service":"chat","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-classroom.json b/public/specs/google/google-classroom.json index 2f29c52d..675302cd 100644 --- a/public/specs/google/google-classroom.json +++ b/public/specs/google/google-classroom.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Classroom API","version":"v1","description":"Manages classes, rosters, and invitations in Google Classroom."},"servers":[{"url":"https://classroom.googleapis.com/"}],"paths":{"/v1/courses":{"get":{"operationId":"classroom.courses.list","x-executor-toolPath":"classroom.courses.list","tags":["Google Classroom API"],"description":"Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseStates","in":"query","required":false,"description":"Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.","schema":{"type":"array","items":{"description":"Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.","enum":["COURSE_STATE_UNSPECIFIED","ACTIVE","ARCHIVED","PROVISIONED","DECLINED","SUSPENDED"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"studentId","in":"query","required":false,"description":"Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `teacher_id` must be empty.","schema":{"description":"Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `teacher_id` must be empty.","type":"string"},"style":"form","explode":false},{"name":"teacherId","in":"query","required":false,"description":"Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `student_id` must be empty.","schema":{"description":"Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `student_id` must be empty.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCoursesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"post":{"operationId":"classroom.courses.create","x-executor-toolPath":"classroom.courses.create","tags":["Google Classroom API"],"description":"Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * CourseTitleCannotContainUrl * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/aliases":{"get":{"operationId":"classroom.courses.aliases.list","x-executor-toolPath":"classroom.courses.aliases.list","tags":["Google Classroom API"],"description":"Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCourseAliasesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"post":{"operationId":"classroom.courses.aliases.create","x-executor-toolPath":"classroom.courses.aliases.create","tags":["Google Classroom API"],"description":"Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseAlias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseAlias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/aliases/{alias}":{"delete":{"operationId":"classroom.courses.aliases.delete","x-executor-toolPath":"classroom.courses.aliases.delete","tags":["Google Classroom API"],"description":"Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"alias","in":"path","required":true,"description":"Alias to delete. This may not be the Classroom-assigned identifier.","schema":{"description":"Alias to delete. This may not be the Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/announcements":{"get":{"operationId":"classroom.courses.announcements.list","x-executor-toolPath":"classroom.courses.announcements.list","tags":["Google Classroom API"],"description":"Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"announcementStates","in":"query","required":false,"description":"Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.","schema":{"type":"array","items":{"description":"Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.","enum":["ANNOUNCEMENT_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"}},"style":"form","explode":true},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","schema":{"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListAnnouncementsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]},"post":{"operationId":"classroom.courses.announcements.create","x-executor-toolPath":"classroom.courses.announcements.create","tags":["Google Classroom API"],"description":"Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]}},"/v1/courses/{courseId}/announcements/{id}":{"get":{"operationId":"classroom.courses.announcements.get","x-executor-toolPath":"classroom.courses.announcements.get","tags":["Google Classroom API"],"description":"Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement.","schema":{"description":"Identifier of the announcement.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]},"delete":{"operationId":"classroom.courses.announcements.delete","x-executor-toolPath":"classroom.courses.announcements.delete","tags":["Google Classroom API"],"description":"Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.","schema":{"description":"Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]},"patch":{"operationId":"classroom.courses.announcements.patch","x-executor-toolPath":"classroom.courses.announcements.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement.","schema":{"description":"Identifier of the announcement.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`","schema":{"description":"Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]}},"/v1/courses/{courseId}/announcements/{id}:modifyAssignees":{"post":{"operationId":"classroom.courses.announcements.modifyAssignees","x-executor-toolPath":"classroom.courses.announcements.modifyAssignees","tags":["Google Classroom API"],"description":"Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement.","schema":{"description":"Identifier of the announcement.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ModifyAnnouncementAssigneesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]}},"/v1/courses/{courseId}/courseWork":{"get":{"operationId":"classroom.courses.courseWork.list","x-executor-toolPath":"classroom.courses.courseWork.list","tags":["Google Classroom API"],"description":"Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseWorkStates","in":"query","required":false,"description":"Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","schema":{"type":"array","items":{"description":"Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","enum":["COURSE_WORK_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`","schema":{"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCourseWorkResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"post":{"operationId":"classroom.courses.courseWork.create","x-executor-toolPath":"classroom.courses.courseWork.create","tags":["Google Classroom API"],"description":"Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/rubric":{"patch":{"operationId":"classroom.courses.courseWork.updateRubric","x-executor-toolPath":"classroom.courses.courseWork.updateRubric","tags":["Google Classroom API"],"description":"Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Optional. Identifier of the rubric.","schema":{"description":"Optional. Identifier of the rubric.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","schema":{"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics":{"get":{"operationId":"classroom.courses.courseWork.rubrics.list","x-executor-toolPath":"classroom.courses.courseWork.rubrics.list","tags":["Google Classroom API"],"description":"Returns a list of rubrics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work doesn't exist or if the user doesn't have access to the corresponding course work.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1.","schema":{"description":"The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListRubricsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"post":{"operationId":"classroom.courses.courseWork.rubrics.create","x-executor-toolPath":"classroom.courses.courseWork.rubrics.create","tags":["Google Classroom API"],"description":"Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}":{"get":{"operationId":"classroom.courses.courseWork.rubrics.get","x-executor-toolPath":"classroom.courses.courseWork.rubrics.get","tags":["Google Classroom API"],"description":"Returns a rubric. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Required. Identifier of the rubric.","schema":{"description":"Required. Identifier of the rubric.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"delete":{"operationId":"classroom.courses.courseWork.rubrics.delete","x-executor-toolPath":"classroom.courses.courseWork.rubrics.delete","tags":["Google Classroom API"],"description":"Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Required. Identifier of the rubric.","schema":{"description":"Required. Identifier of the rubric.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]},"patch":{"operationId":"classroom.courses.courseWork.rubrics.patch","x-executor-toolPath":"classroom.courses.courseWork.rubrics.patch","tags":["Google Classroom API"],"description":"Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Optional. Identifier of the rubric.","schema":{"description":"Optional. Identifier of the rubric.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","schema":{"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions":{"get":{"operationId":"classroom.courses.courseWork.studentSubmissions.list","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.list","tags":["Google Classroom API"],"description":"Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. A hyphen (`-`) may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the student work to request. This may be set to the string literal `\"-\"` to request student work for all course work in the specified course.","schema":{"description":"Identifier of the student work to request. This may be set to the string literal `\"-\"` to request student work for all course work in the specified course.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"late","in":"query","required":false,"description":"Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.","schema":{"description":"Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.","enum":["LATE_VALUES_UNSPECIFIED","LATE_ONLY","NOT_LATE_ONLY"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"states","in":"query","required":false,"description":"Requested submission states. If specified, returned student submissions match one of the specified submission states.","schema":{"type":"array","items":{"description":"Requested submission states. If specified, returned student submissions match one of the specified submission states.","enum":["SUBMISSION_STATE_UNSPECIFIED","NEW","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userId","in":"query","required":false,"description":"Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListStudentSubmissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}":{"get":{"operationId":"classroom.courses.courseWork.studentSubmissions.get","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.get","tags":["Google Classroom API"],"description":"Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"patch":{"operationId":"classroom.courses.courseWork.studentSubmissions.patch","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment with Grade Sync enabled on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work or an add-on attachment on the corresponding course work with Grade Sync enabled, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`","schema":{"description":"Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.modifyAttachments","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.modifyAttachments","tags":["Google Classroom API"],"description":"Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ModifyAttachmentsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.reclaim","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.reclaim","tags":["Google Classroom API"],"description":"Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ReclaimStudentSubmissionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.return","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.return","tags":["Google Classroom API"],"description":"Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ReturnStudentSubmissionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.turnIn","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.turnIn","tags":["Google Classroom API"],"description":"Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_TurnInStudentSubmissionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me"]}},"/v1/courses/{courseId}/courseWork/{id}":{"get":{"operationId":"classroom.courses.courseWork.get","x-executor-toolPath":"classroom.courses.courseWork.get","tags":["Google Classroom API"],"description":"Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"delete":{"operationId":"classroom.courses.courseWork.delete","x-executor-toolPath":"classroom.courses.courseWork.delete","tags":["Google Classroom API"],"description":"Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.","schema":{"description":"Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]},"patch":{"operationId":"classroom.courses.courseWork.patch","x-executor-toolPath":"classroom.courses.courseWork.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work or an add-on attachment on the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` * `learning_goals`","schema":{"description":"Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` * `learning_goals`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{id}:modifyAssignees":{"post":{"operationId":"classroom.courses.courseWork.modifyAssignees","x-executor-toolPath":"classroom.courses.courseWork.modifyAssignees","tags":["Google Classroom API"],"description":"Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the coursework.","schema":{"description":"Identifier of the coursework.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ModifyCourseWorkAssigneesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWorkMaterials":{"get":{"operationId":"classroom.courses.courseWorkMaterials.list","x-executor-toolPath":"classroom.courses.courseWorkMaterials.list","tags":["Google Classroom API"],"description":"Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseWorkMaterialStates","in":"query","required":false,"description":"Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","schema":{"type":"array","items":{"description":"Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","enum":["COURSEWORK_MATERIAL_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"materialDriveId","in":"query","required":false,"description":"Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `material_link` is also specified, course work material must have materials matching both filters.","schema":{"description":"Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `material_link` is also specified, course work material must have materials matching both filters.","type":"string"},"style":"form","explode":false},{"name":"materialLink","in":"query","required":false,"description":"Optional filtering for course work material with at least one link material whose URL partially matches the provided string.","schema":{"description":"Optional filtering for course work material with at least one link material whose URL partially matches the provided string.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","schema":{"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCourseWorkMaterialResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]},"post":{"operationId":"classroom.courses.courseWorkMaterials.create","x-executor-toolPath":"classroom.courses.courseWorkMaterials.create","tags":["Google Classroom API"],"description":"Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}},"/v1/courses/{courseId}/courseWorkMaterials/{id}":{"get":{"operationId":"classroom.courses.courseWorkMaterials.get","x-executor-toolPath":"classroom.courses.courseWorkMaterials.get","tags":["Google Classroom API"],"description":"Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work material.","schema":{"description":"Identifier of the course work material.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]},"delete":{"operationId":"classroom.courses.courseWorkMaterials.delete","x-executor-toolPath":"classroom.courses.courseWorkMaterials.delete","tags":["Google Classroom API"],"description":"Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.","schema":{"description":"Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]},"patch":{"operationId":"classroom.courses.courseWorkMaterials.patch","x-executor-toolPath":"classroom.courses.courseWorkMaterials.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work material.","schema":{"description":"Identifier of the course work material.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` * `learning_goals`","schema":{"description":"Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` * `learning_goals`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}},"/v1/courses/{courseId}/gradingPeriodSettings":{"get":{"operationId":"classroom.courses.getGradingPeriodSettings","x-executor-toolPath":"classroom.courses.getGradingPeriodSettings","tags":["Google Classroom API"],"description":"Returns the grading period settings in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. The identifier of the course.","schema":{"description":"Required. The identifier of the course.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GradingPeriodSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"patch":{"operationId":"classroom.courses.updateGradingPeriodSettings","x-executor-toolPath":"classroom.courses.updateGradingPeriodSettings","tags":["Google Classroom API"],"description":"Updates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course owner must be eligible to modify Grading Periods. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for access errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. The identifier of the course.","schema":{"description":"Required. The identifier of the course.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework`","schema":{"description":"Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GradingPeriodSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GradingPeriodSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/students":{"get":{"operationId":"classroom.courses.students.list","x-executor-toolPath":"classroom.courses.students.list","tags":["Google Classroom API"],"description":"Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListStudentsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]},"post":{"operationId":"classroom.courses.students.create","x-executor-toolPath":"classroom.courses.students.create","tags":["Google Classroom API"],"description":"Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enrollmentCode","in":"query","required":false,"description":"Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.","schema":{"description":"Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Student"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Student"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/students/{userId}":{"get":{"operationId":"classroom.courses.students.get","x-executor-toolPath":"classroom.courses.students.get","tags":["Google Classroom API"],"description":"Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Student"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]},"delete":{"operationId":"classroom.courses.students.delete","x-executor-toolPath":"classroom.courses.students.delete","tags":["Google Classroom API"],"description":"Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/teachers":{"get":{"operationId":"classroom.courses.teachers.list","x-executor-toolPath":"classroom.courses.teachers.list","tags":["Google Classroom API"],"description":"Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListTeachersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/teachers/{userId}":{"get":{"operationId":"classroom.courses.teachers.get","x-executor-toolPath":"classroom.courses.teachers.get","tags":["Google Classroom API"],"description":"Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Teacher"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]},"delete":{"operationId":"classroom.courses.teachers.delete","x-executor-toolPath":"classroom.courses.teachers.delete","tags":["Google Classroom API"],"description":"Removes the specified teacher from the specified course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/topics":{"get":{"operationId":"classroom.courses.topics.list","x-executor-toolPath":"classroom.courses.topics.list","tags":["Google Classroom API"],"description":"Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListTopicResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]},"post":{"operationId":"classroom.courses.topics.create","x-executor-toolPath":"classroom.courses.topics.create","tags":["Google Classroom API"],"description":"Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `FAILED_PRECONDITION` for the following request error: * CourseTopicLimitReached * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]}},"/v1/courses/{courseId}/topics/{id}":{"get":{"operationId":"classroom.courses.topics.get","x-executor-toolPath":"classroom.courses.topics.get","tags":["Google Classroom API"],"description":"Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course.","schema":{"description":"Identifier of the course.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the topic.","schema":{"description":"Identifier of the topic.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]},"delete":{"operationId":"classroom.courses.topics.delete","x-executor-toolPath":"classroom.courses.topics.delete","tags":["Google Classroom API"],"description":"Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the topic to delete.","schema":{"description":"Identifier of the topic to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]},"patch":{"operationId":"classroom.courses.topics.patch","x-executor-toolPath":"classroom.courses.topics.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course or topic does not exist","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the topic.","schema":{"description":"Identifier of the topic.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name`","schema":{"description":"Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]}},"/v1/courses/{id}":{"get":{"operationId":"classroom.courses.get","x-executor-toolPath":"classroom.courses.get","tags":["Google Classroom API"],"description":"Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"put":{"operationId":"classroom.courses.update","x-executor-toolPath":"classroom.courses.update","tags":["Google Classroom API"],"description":"Updates a course. Note: Unlike other fields, `levels` is not cleared if omitted from the request. The `UpdateCourse` method only modifies `levels` if it is explicitly provided; otherwise, the existing value is preserved. Use the `PatchCourse` method to clear the `levels` field. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrl","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"delete":{"operationId":"classroom.courses.delete","x-executor-toolPath":"classroom.courses.delete","tags":["Google Classroom API"],"description":"Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"patch":{"operationId":"classroom.courses.patch","x-executor-toolPath":"classroom.courses.patch","tags":["Google Classroom API"],"description":"Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * InactiveCourseOwner * IneligibleOwner * CourseTitleCannotContainUrl","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `learningStandardSettings` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`","schema":{"description":"Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `learningStandardSettings` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/invitations":{"get":{"operationId":"classroom.invitations.list","x-executor-toolPath":"classroom.invitations.list","tags":["Google Classroom API"],"description":"Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseId","in":"query","required":false,"description":"Restricts returned invitations to those for a course with the specified identifier.","schema":{"description":"Restricts returned invitations to those for a course with the specified identifier.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userId","in":"query","required":false,"description":"Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListInvitationsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]},"post":{"operationId":"classroom.invitations.create","x-executor-toolPath":"classroom.invitations.create","tags":["Google Classroom API"],"description":"Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION`: * if the requested user's account is disabled. * if the user already has this role or a role with greater permissions. * for the following request errors: * IneligibleOwner * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Invitation"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Invitation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/invitations/{id}":{"get":{"operationId":"classroom.invitations.get","x-executor-toolPath":"classroom.invitations.get","tags":["Google Classroom API"],"description":"Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the invitation to return.","schema":{"description":"Identifier of the invitation to return.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Invitation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]},"delete":{"operationId":"classroom.invitations.delete","x-executor-toolPath":"classroom.invitations.delete","tags":["Google Classroom API"],"description":"Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the invitation to delete.","schema":{"description":"Identifier of the invitation to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/invitations/{id}:accept":{"post":{"operationId":"classroom.invitations.accept","x-executor-toolPath":"classroom.invitations.accept","tags":["Google Classroom API"],"description":"Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the invitation to accept.","schema":{"description":"Identifier of the invitation to accept.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/userProfiles/{studentId}/guardianInvitations":{"get":{"operationId":"classroom.userProfiles.guardianInvitations.list","x-executor-toolPath":"classroom.userProfiles.guardianInvitations.list","tags":["Google Classroom API"],"description":"Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.","parameters":[{"name":"studentId","in":"path","required":true,"description":"The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.","schema":{"description":"The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"invitedEmailAddress","in":"query","required":false,"description":"If specified, only results with the specified `invited_email_address` are returned.","schema":{"description":"If specified, only results with the specified `invited_email_address` are returned.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"states","in":"query","required":false,"description":"If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned.","schema":{"type":"array","items":{"description":"If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned.","enum":["GUARDIAN_INVITATION_STATE_UNSPECIFIED","PENDING","COMPLETE"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListGuardianInvitationsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}":{"get":{"operationId":"classroom.userProfiles.guardianInvitations.get","x-executor-toolPath":"classroom.userProfiles.guardianInvitations.get","tags":["Google Classroom API"],"description":"Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.","parameters":[{"name":"studentId","in":"path","required":true,"description":"The ID of the student whose guardian invitation is being requested.","schema":{"description":"The ID of the student whose guardian invitation is being requested.","type":"string"}},{"name":"invitationId","in":"path","required":true,"description":"The `id` field of the `GuardianInvitation` being requested.","schema":{"description":"The `id` field of the `GuardianInvitation` being requested.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GuardianInvitation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{studentId}/guardians":{"get":{"operationId":"classroom.userProfiles.guardians.list","x-executor-toolPath":"classroom.userProfiles.guardians.list","tags":["Google Classroom API"],"description":"Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.","parameters":[{"name":"studentId","in":"path","required":true,"description":"Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.","schema":{"description":"Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"invitedEmailAddress","in":"query","required":false,"description":"Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.","schema":{"description":"Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListGuardiansResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{studentId}/guardians/{guardianId}":{"get":{"operationId":"classroom.userProfiles.guardians.get","x-executor-toolPath":"classroom.userProfiles.guardians.get","tags":["Google Classroom API"],"description":"Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.","parameters":[{"name":"studentId","in":"path","required":true,"description":"The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"guardianId","in":"path","required":true,"description":"The `id` field from a `Guardian`.","schema":{"description":"The `id` field from a `Guardian`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Guardian"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{userId}":{"get":{"operationId":"classroom.userProfiles.get","x-executor-toolPath":"classroom.userProfiles.get","tags":["Google Classroom API"],"description":"Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.","parameters":[{"name":"userId","in":"path","required":true,"description":"Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_UserProfile"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]}}},"components":{"schemas":{"classroom_v1_AddOnAttachment":{"description":"An add-on attachment on a post.","type":"object","properties":{"copyHistory":{"description":"Output only. Identifiers of attachments that were previous copies of this attachment. If the attachment was previously copied by virtue of its parent post being copied, this enumerates the identifiers of attachments that were its previous copies in ascending chronological order of copy.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CopyHistory"}},"courseId":{"description":"Immutable. Identifier of the course.","type":"string"},"dueDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"dueTime":{"$ref":"#/components/schemas/classroom_v1_TimeOfDay"},"id":{"description":"Immutable. Classroom-assigned identifier for this attachment, unique per post.","type":"string"},"itemId":{"description":"Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. Unique per course.","type":"string"},"maxPoints":{"description":"Maximum grade for this attachment. Can only be set if `studentWorkReviewUri` is set. Set to a non-zero value to indicate that the attachment supports grade passback. If set, this must be a non-negative integer value. When set to zero, the attachment will not support grade passback.","format":"double","type":"number"},"postId":{"description":"Immutable. Deprecated, use `item_id` instead.","type":"string"},"studentViewUri":{"$ref":"#/components/schemas/classroom_v1_EmbedUri"},"studentWorkReviewUri":{"$ref":"#/components/schemas/classroom_v1_EmbedUri"},"teacherViewUri":{"$ref":"#/components/schemas/classroom_v1_EmbedUri"},"title":{"description":"Required. Title of this attachment. The title must be between 1 and 1000 characters.","type":"string"}}},"classroom_v1_AddOnAttachmentStudentSubmission":{"description":"Payload for grade update requests.","type":"object","properties":{"courseWorkSubmissionId":{"description":"Output only. Identifier of the course work submission under which this attachment submission was made.","readOnly":true,"type":"string"},"id":{"description":"Output only. Classroom-assigned identifier for this student submission. This is unique among submissions for the relevant course work and add-on attachment combination.","readOnly":true,"type":"string"},"pointsEarned":{"description":"Student grade on this attachment. If unset, no grade was set.","format":"double","type":"number"},"postSubmissionState":{"description":"Submission state of add-on attachment's parent post (i.e. assignment).","enum":["SUBMISSION_STATE_UNSPECIFIED","NEW","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT"],"type":"string"},"userId":{"description":"Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. See [`courseWork.studentSubmissions.get`](/workspace/classroom/reference/rest/v1/courses.courseWork.studentSubmissions/get#authorization-scopes) for the list of acceptable OAuth scopes for this field. Read-only.","type":"string"}}},"classroom_v1_AddOnContext":{"description":"Attachment-relevant metadata for Classroom add-ons in the context of a specific post.","type":"object","properties":{"courseId":{"description":"Immutable. Identifier of the course.","type":"string"},"itemId":{"description":"Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.","type":"string"},"postId":{"description":"Immutable. Deprecated, use `item_id` instead.","type":"string"},"studentContext":{"$ref":"#/components/schemas/classroom_v1_StudentContext"},"supportsStudentWork":{"description":"Optional. Whether the post allows the teacher to see student work and passback grades.","type":"boolean"},"teacherContext":{"$ref":"#/components/schemas/classroom_v1_TeacherContext"}}},"classroom_v1_Announcement":{"description":"Announcement created by a teacher for students of the course","type":"object","properties":{"alternateLink":{"description":"Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.","type":"string"},"assigneeMode":{"description":"Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"creationTime":{"description":"Timestamp when this announcement was created. Read-only.","format":"google-datetime","type":"string"},"creatorUserId":{"description":"Identifier for the user that created the announcement. Read-only.","type":"string"},"id":{"description":"Classroom-assigned identifier of this announcement, unique per course. Read-only.","type":"string"},"individualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_IndividualStudentsOptions"},"materials":{"description":"Additional materials. Announcements must have no more than 20 material items.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Material"}},"scheduledTime":{"description":"Optional timestamp when this announcement is scheduled to be published.","format":"google-datetime","type":"string"},"state":{"description":"Status of this announcement. If unspecified, the default state is `DRAFT`.","enum":["ANNOUNCEMENT_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"},"text":{"description":"Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.","type":"string"},"updateTime":{"description":"Timestamp of the most recent change to this announcement. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_Assignment":{"description":"Additional details for assignments.","type":"object","properties":{"studentWorkFolder":{"$ref":"#/components/schemas/classroom_v1_DriveFolder"}}},"classroom_v1_AssignmentSubmission":{"description":"Student work for an assignment.","type":"object","properties":{"attachments":{"description":"Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Attachment"}}}},"classroom_v1_Attachment":{"description":"Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_DriveFile"},"form":{"$ref":"#/components/schemas/classroom_v1_Form"},"link":{"$ref":"#/components/schemas/classroom_v1_Link"},"youTubeVideo":{"$ref":"#/components/schemas/classroom_v1_YouTubeVideo"}}},"classroom_v1_CloudPubsubTopic":{"description":"A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.","type":"object","properties":{"topicName":{"description":"The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).","type":"string"}}},"classroom_v1_CopyHistory":{"description":"Identifier of a previous copy of a given attachment.","type":"object","properties":{"attachmentId":{"description":"Immutable. Identifier of the attachment.","type":"string"},"courseId":{"description":"Immutable. Identifier of the course.","type":"string"},"itemId":{"description":"Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.","type":"string"},"postId":{"description":"Immutable. Deprecated, use `item_id` instead.","type":"string"}}},"classroom_v1_Course":{"description":"A Course in Classroom.","type":"object","properties":{"alternateLink":{"description":"Absolute link to this course in the Classroom web UI. Read-only.","type":"string"},"calendarId":{"description":"The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. The Calendar for a course is created asynchronously when the course is set to `CourseState.ACTIVE` for the first time (at creation time or when it is updated to `ACTIVE` through the UI or the API). The Calendar ID will not be populated until the creation process is completed. Read-only.","type":"string"},"courseGroupEmail":{"description":"The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.","type":"string"},"courseMaterialSets":{"description":"Sets of materials that appear on the \"about\" page of this course. Read-only.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseMaterialSet"}},"courseState":{"description":"State of the course. If unspecified, the default state is `PROVISIONED`.","enum":["COURSE_STATE_UNSPECIFIED","ACTIVE","ARCHIVED","PROVISIONED","DECLINED","SUSPENDED"],"type":"string"},"creationTime":{"description":"Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.","format":"google-datetime","type":"string"},"description":{"description":"Optional description. For example, \"We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!\" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.","type":"string"},"descriptionHeading":{"description":"Optional heading for the description. For example, \"Welcome to 10th Grade Biology.\" If set, this field must be a valid UTF-8 string and no longer than 3600 characters.","type":"string"},"enrollmentCode":{"description":"Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.","type":"string"},"gradebookSettings":{"$ref":"#/components/schemas/classroom_v1_GradebookSettings"},"guardiansEnabled":{"description":"Whether or not guardian notifications are enabled for this course. Read-only.","type":"boolean"},"id":{"description":"Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.","type":"string"},"levels":{"description":"Optional. Levels for the course. Examples: \"9th grade\", \"Middle school\", \"4th - 5th\", \"K-2\", \"3000\". If set, this field must be a valid UTF-8 string and fewer than 1000 characters. This field can only be cleared using the `PatchCourse` method.","type":"string"},"name":{"description":"Name of the course. For example, \"10th Grade Biology\". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.","type":"string"},"ownerId":{"description":"The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.","type":"string"},"room":{"description":"Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters.","type":"string"},"section":{"description":"Section of the course. For example, \"Period 2\". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.","type":"string"},"subject":{"description":"Optional. The subject of the course.","type":"string"},"teacherFolder":{"$ref":"#/components/schemas/classroom_v1_DriveFolder"},"teacherGroupEmail":{"description":"The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.","type":"string"},"updateTime":{"description":"Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_CourseAlias":{"description":"Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.","type":"object","properties":{"alias":{"description":"Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.","type":"string"}}},"classroom_v1_CourseMaterial":{"description":"A material attached to a course as part of a material set.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_DriveFile"},"form":{"$ref":"#/components/schemas/classroom_v1_Form"},"link":{"$ref":"#/components/schemas/classroom_v1_Link"},"youTubeVideo":{"$ref":"#/components/schemas/classroom_v1_YouTubeVideo"}}},"classroom_v1_CourseMaterialSet":{"description":"A set of materials that appears on the \"About\" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.","type":"object","properties":{"materials":{"description":"Materials attached to this set.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseMaterial"}},"title":{"description":"Title for this set.","type":"string"}}},"classroom_v1_CourseRosterChangesInfo":{"description":"Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.","type":"object","properties":{"courseId":{"description":"The `course_id` of the course to subscribe to roster changes for.","type":"string"}}},"classroom_v1_CourseWork":{"description":"Course work created by a teacher for students of the course.","type":"object","properties":{"alternateLink":{"description":"Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.","type":"string"},"assigneeMode":{"description":"Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"assignment":{"$ref":"#/components/schemas/classroom_v1_Assignment"},"associatedWithDeveloper":{"description":"Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.","type":"boolean"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"creationTime":{"description":"Timestamp when this course work was created. Read-only.","format":"google-datetime","type":"string"},"creatorUserId":{"description":"Identifier for the user that created the coursework. Read-only.","type":"string"},"description":{"description":"Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.","type":"string"},"dueDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"dueTime":{"$ref":"#/components/schemas/classroom_v1_TimeOfDay"},"gradeCategory":{"$ref":"#/components/schemas/classroom_v1_GradeCategory"},"gradingPeriodId":{"description":"Identifier of the grading period associated with the coursework. * At creation, if unspecified, the grading period ID will be set based on the `dueDate` (or `scheduledTime` if no `dueDate` is set). * To indicate no association to any grading period, set this field to an empty string (\"\"). * If specified, it must match an existing grading period ID in the course.","type":"string"},"id":{"description":"Classroom-assigned identifier of this course work, unique per course. Read-only.","type":"string"},"individualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_IndividualStudentsOptions"},"materials":{"description":"Additional materials. CourseWork must have no more than 20 material items.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Material"}},"maxPoints":{"description":"Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.","format":"double","type":"number"},"multipleChoiceQuestion":{"$ref":"#/components/schemas/classroom_v1_MultipleChoiceQuestion"},"scheduledTime":{"description":"Optional timestamp when this course work is scheduled to be published.","format":"google-datetime","type":"string"},"state":{"description":"Status of this course work. If unspecified, the default state is `DRAFT`.","enum":["COURSE_WORK_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"},"submissionModificationMode":{"description":"Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.","enum":["SUBMISSION_MODIFICATION_MODE_UNSPECIFIED","MODIFIABLE_UNTIL_TURNED_IN","MODIFIABLE"],"type":"string"},"title":{"description":"Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.","type":"string"},"topicId":{"description":"Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.","type":"string"},"updateTime":{"description":"Timestamp of the most recent change to this course work. Read-only.","format":"google-datetime","type":"string"},"workType":{"description":"Type of this course work. The type is set when the course work is created and cannot be changed.","enum":["COURSE_WORK_TYPE_UNSPECIFIED","ASSIGNMENT","SHORT_ANSWER_QUESTION","MULTIPLE_CHOICE_QUESTION"],"type":"string"}}},"classroom_v1_CourseWorkChangesInfo":{"description":"Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.","type":"object","properties":{"courseId":{"description":"The `course_id` of the course to subscribe to work changes for.","type":"string"}}},"classroom_v1_CourseWorkMaterial":{"description":"Course work material created by a teacher for students of the course","type":"object","properties":{"alternateLink":{"description":"Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.","type":"string"},"assigneeMode":{"description":"Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"creationTime":{"description":"Timestamp when this course work material was created. Read-only.","format":"google-datetime","type":"string"},"creatorUserId":{"description":"Identifier for the user that created the course work material. Read-only.","type":"string"},"description":{"description":"Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.","type":"string"},"id":{"description":"Classroom-assigned identifier of this course work material, unique per course. Read-only.","type":"string"},"individualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_IndividualStudentsOptions"},"materials":{"description":"Additional materials. A course work material must have no more than 20 material items.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Material"}},"scheduledTime":{"description":"Optional timestamp when this course work material is scheduled to be published.","format":"google-datetime","type":"string"},"state":{"description":"Status of this course work material. If unspecified, the default state is `DRAFT`.","enum":["COURSEWORK_MATERIAL_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"},"title":{"description":"Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.","type":"string"},"topicId":{"description":"Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.","type":"string"},"updateTime":{"description":"Timestamp of the most recent change to this course work material. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_Criterion":{"description":"A rubric criterion. Each criterion is a dimension on which performance is rated.","type":"object","properties":{"description":{"description":"The description of the criterion.","type":"string"},"id":{"description":"The criterion ID. On creation, an ID is assigned.","type":"string"},"levels":{"description":"The list of levels within this criterion.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Level"}},"title":{"description":"The title of the criterion.","type":"string"}}},"classroom_v1_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":{"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.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"classroom_v1_DriveFile":{"description":"Representation of a Google Drive file.","type":"object","properties":{"alternateLink":{"description":"URL that can be used to access the Drive item. Read-only.","type":"string"},"id":{"description":"Drive API resource ID.","type":"string"},"thumbnailUrl":{"description":"URL of a thumbnail image of the Drive item. Read-only.","type":"string"},"title":{"description":"Title of the Drive item. Read-only.","type":"string"}}},"classroom_v1_DriveFolder":{"description":"Representation of a Google Drive folder.","type":"object","properties":{"alternateLink":{"description":"URL that can be used to access the Drive folder. Read-only.","type":"string"},"id":{"description":"Drive API resource ID.","type":"string"},"title":{"description":"Title of the Drive folder. Read-only.","type":"string"}}},"classroom_v1_EmbedUri":{"description":"URI to be iframed after being populated with query parameters.","type":"object","properties":{"uri":{"description":"Required. URI to be iframed after being populated with query parameters. This must be a valid UTF-8 string containing between 1 and 1800 characters.","type":"string"}}},"classroom_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"classroom_v1_Feed":{"description":"A class of notifications that an application can register to receive. For example: \"all roster changes for a domain\".","type":"object","properties":{"courseRosterChangesInfo":{"$ref":"#/components/schemas/classroom_v1_CourseRosterChangesInfo"},"courseWorkChangesInfo":{"$ref":"#/components/schemas/classroom_v1_CourseWorkChangesInfo"},"feedType":{"description":"The type of feed.","enum":["FEED_TYPE_UNSPECIFIED","DOMAIN_ROSTER_CHANGES","COURSE_ROSTER_CHANGES","COURSE_WORK_CHANGES"],"type":"string"}}},"classroom_v1_Form":{"description":"Google Forms item.","type":"object","properties":{"formUrl":{"description":"URL of the form.","type":"string"},"responseUrl":{"description":"URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.","type":"string"},"thumbnailUrl":{"description":"URL of a thumbnail image of the Form. Read-only.","type":"string"},"title":{"description":"Title of the Form. Read-only.","type":"string"}}},"classroom_v1_GeminiGem":{"description":"Gemini Gem link.","type":"object","properties":{"id":{"description":"Gems resource id.","type":"string"},"title":{"description":"Title of the Gem.","type":"string"},"url":{"description":"URL that can be used to access the Gem.","type":"string"}}},"classroom_v1_GlobalPermission":{"description":"Global user permission description.","type":"object","properties":{"permission":{"description":"Permission value.","enum":["PERMISSION_UNSPECIFIED","CREATE_COURSE"],"type":"string"}}},"classroom_v1_GradeCategory":{"description":"Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.","type":"object","properties":{"defaultGradeDenominator":{"description":"Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS.","format":"int32","type":"integer"},"id":{"description":"ID of the grade category.","type":"string"},"name":{"description":"Name of the grade category.","type":"string"},"weight":{"description":"The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES.","format":"int32","type":"integer"}}},"classroom_v1_GradeHistory":{"description":"The history of each grade on this submission.","type":"object","properties":{"actorUserId":{"description":"The teacher who made the grade change.","type":"string"},"gradeChangeType":{"description":"The type of grade change at this time in the submission grade history.","enum":["UNKNOWN_GRADE_CHANGE_TYPE","DRAFT_GRADE_POINTS_EARNED_CHANGE","ASSIGNED_GRADE_POINTS_EARNED_CHANGE","MAX_POINTS_CHANGE"],"type":"string"},"gradeTimestamp":{"description":"When the grade of the submission was changed.","format":"google-datetime","type":"string"},"maxPoints":{"description":"The denominator of the grade at this time in the submission grade history.","format":"double","type":"number"},"pointsEarned":{"description":"The numerator of the grade at this time in the submission grade history.","format":"double","type":"number"}}},"classroom_v1_GradebookSettings":{"description":"The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.","type":"object","properties":{"calculationType":{"description":"Indicates how the overall grade is calculated.","enum":["CALCULATION_TYPE_UNSPECIFIED","TOTAL_POINTS","WEIGHTED_CATEGORIES"],"type":"string"},"displaySetting":{"description":"Indicates who can see the overall grade..","enum":["DISPLAY_SETTING_UNSPECIFIED","SHOW_OVERALL_GRADE","HIDE_OVERALL_GRADE","SHOW_TEACHERS_ONLY"],"type":"string"},"gradeCategories":{"description":"Grade categories that are available for coursework in the course.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GradeCategory"}}}},"classroom_v1_GradingPeriod":{"description":"An individual grading period. Grading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the end_date of a grading period is 2024-01-25, then the start_date of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course.","type":"object","properties":{"endDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"id":{"description":"Output only. System generated grading period ID. Read-only.","readOnly":true,"type":"string"},"startDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"title":{"description":"Required. Title of the grading period. For example, “Semester 1”.","type":"string"}}},"classroom_v1_GradingPeriodSettings":{"description":"Grading period settings that include all the individual grading periods in a course.","type":"object","properties":{"applyToExistingCoursework":{"description":"Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update `GradingPeriodSettings`. If not previously set, the default is False.","type":"boolean"},"gradingPeriods":{"description":"The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GradingPeriod"}}}},"classroom_v1_Guardian":{"description":"Association between a student and a guardian of that student. The guardian may receive information about the student's course work.","type":"object","properties":{"guardianId":{"description":"Identifier for the guardian.","type":"string"},"guardianProfile":{"$ref":"#/components/schemas/classroom_v1_UserProfile"},"invitedEmailAddress":{"description":"The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.","type":"string"},"studentId":{"description":"Identifier for the student to whom the guardian relationship applies.","type":"string"}}},"classroom_v1_GuardianInvitation":{"description":"An invitation to become the guardian of a specified user, sent to a specified email address.","type":"object","properties":{"creationTime":{"description":"The time that this invitation was created. Read-only.","format":"google-datetime","type":"string"},"invitationId":{"description":"Unique identifier for this invitation. Read-only.","type":"string"},"invitedEmailAddress":{"description":"Email address that the invitation was sent to. This field is only visible to domain administrators.","type":"string"},"state":{"description":"The state that this invitation is in.","enum":["GUARDIAN_INVITATION_STATE_UNSPECIFIED","PENDING","COMPLETE"],"type":"string"},"studentId":{"description":"ID of the student (in standard format)","type":"string"}}},"classroom_v1_IndividualStudentsOptions":{"description":"Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.","type":"object","properties":{"studentIds":{"description":"Identifiers for the students that have access to the coursework/announcement.","type":"array","items":{"type":"string"}}}},"classroom_v1_Invitation":{"description":"An invitation to join a course.","type":"object","properties":{"courseId":{"description":"Identifier of the course to invite the user to.","type":"string"},"id":{"description":"Identifier assigned by Classroom. Read-only.","type":"string"},"role":{"description":"Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.","enum":["COURSE_ROLE_UNSPECIFIED","STUDENT","TEACHER","OWNER"],"type":"string"},"userId":{"description":"Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}}},"classroom_v1_Level":{"description":"A level of the criterion.","type":"object","properties":{"description":{"description":"The description of the level.","type":"string"},"id":{"description":"The level ID. On creation, an ID is assigned.","type":"string"},"points":{"description":"Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.","format":"double","type":"number"},"title":{"description":"The title of the level. If the level has no points set, title must be set.","type":"string"}}},"classroom_v1_Link":{"description":"URL item.","type":"object","properties":{"thumbnailUrl":{"description":"URL of a thumbnail image of the target URL. Read-only.","type":"string"},"title":{"description":"Title of the target of the URL. Read-only.","type":"string"},"url":{"description":"URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.","type":"string"}}},"classroom_v1_ListAddOnAttachmentsResponse":{"description":"Response when listing add-on attachments.","type":"object","properties":{"addOnAttachments":{"description":"Attachments under the given post.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_AddOnAttachment"}},"nextPageToken":{"description":"A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"}}},"classroom_v1_ListAnnouncementsResponse":{"description":"Response when listing course work.","type":"object","properties":{"announcements":{"description":"Announcement items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Announcement"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCourseAliasesResponse":{"description":"Response when listing course aliases.","type":"object","properties":{"aliases":{"description":"The course aliases.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseAlias"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCourseWorkMaterialResponse":{"description":"Response when listing course work material.","type":"object","properties":{"courseWorkMaterial":{"description":"Course work material items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCourseWorkResponse":{"description":"Response when listing course work.","type":"object","properties":{"courseWork":{"description":"Course work items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCoursesResponse":{"description":"Response when listing courses.","type":"object","properties":{"courses":{"description":"Courses that match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Course"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListGuardianInvitationsResponse":{"description":"Response when listing guardian invitations.","type":"object","properties":{"guardianInvitations":{"description":"Guardian invitations that matched the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GuardianInvitation"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListGuardiansResponse":{"description":"Response when listing guardians.","type":"object","properties":{"guardians":{"description":"Guardians on this page of results that met the criteria specified in the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Guardian"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListInvitationsResponse":{"description":"Response when listing invitations.","type":"object","properties":{"invitations":{"description":"Invitations that match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Invitation"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListRubricsResponse":{"description":"Response when listing rubrics.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"rubrics":{"description":"Rubrics that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"classroom_v1_ListStudentGroupMembersResponse":{"description":"Response when listing students in a group.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"studentGroupMembers":{"description":"The student group members.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_StudentGroupMember"}}}},"classroom_v1_ListStudentGroupsResponse":{"description":"Response when listing student groups.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"studentGroups":{"description":"The student groups.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_StudentGroup"}}}},"classroom_v1_ListStudentSubmissionsResponse":{"description":"Response when listing student submissions.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"studentSubmissions":{"description":"Student work that matches the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}},"classroom_v1_ListStudentsResponse":{"description":"Response when listing students.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"students":{"description":"Students who match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Student"}}}},"classroom_v1_ListTeachersResponse":{"description":"Response when listing teachers.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"teachers":{"description":"Teachers who match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Teacher"}}}},"classroom_v1_ListTopicResponse":{"description":"Response when listing topics.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"topic":{"description":"Topic items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}},"classroom_v1_Material":{"description":"Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_SharedDriveFile"},"form":{"$ref":"#/components/schemas/classroom_v1_Form"},"gem":{"$ref":"#/components/schemas/classroom_v1_GeminiGem"},"link":{"$ref":"#/components/schemas/classroom_v1_Link"},"notebook":{"$ref":"#/components/schemas/classroom_v1_NotebookLmNotebook"},"youtubeVideo":{"$ref":"#/components/schemas/classroom_v1_YouTubeVideo"}}},"classroom_v1_ModifyAnnouncementAssigneesRequest":{"description":"Request to modify assignee mode and options of an announcement.","type":"object","properties":{"assigneeMode":{"description":"Mode of the announcement describing whether it is accessible by all students or specified individual students.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"modifyIndividualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_ModifyIndividualStudentsOptions"}}},"classroom_v1_ModifyAttachmentsRequest":{"description":"Request to modify the attachments of a student submission.","type":"object","properties":{"addAttachments":{"description":"Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Attachment"}}}},"classroom_v1_ModifyCourseWorkAssigneesRequest":{"description":"Request to modify assignee mode and options of a coursework.","type":"object","properties":{"assigneeMode":{"description":"Mode of the coursework describing whether it will be assigned to all students or specified individual students.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"modifyIndividualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_ModifyIndividualStudentsOptions"}}},"classroom_v1_ModifyIndividualStudentsOptions":{"description":"Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.","type":"object","properties":{"addStudentIds":{"description":"IDs of students to be added as having access to this coursework/announcement.","type":"array","items":{"type":"string"}},"removeStudentIds":{"description":"IDs of students to be removed from having access to this coursework/announcement.","type":"array","items":{"type":"string"}}}},"classroom_v1_MultipleChoiceQuestion":{"description":"Additional details for multiple-choice questions.","type":"object","properties":{"choices":{"description":"Possible choices.","type":"array","items":{"type":"string"}}}},"classroom_v1_MultipleChoiceSubmission":{"description":"Student work for a multiple-choice question.","type":"object","properties":{"answer":{"description":"Student's select choice.","type":"string"}}},"classroom_v1_Name":{"description":"Details of the user's name.","type":"object","properties":{"familyName":{"description":"The user's last name. Read-only.","type":"string"},"fullName":{"description":"The user's full name formed by concatenating the first and last name values. Read-only.","type":"string"},"givenName":{"description":"The user's first name. Read-only.","type":"string"}}},"classroom_v1_NotebookLmNotebook":{"description":"NotebookLM Notebook link.","type":"object","properties":{"id":{"description":"Notebook resource id.","type":"string"},"title":{"description":"Title of the Notebook.","type":"string"},"url":{"description":"URL that can be used to access the Notebook.","type":"string"}}},"classroom_v1_ReclaimStudentSubmissionRequest":{"description":"Request to reclaim a student submission.","type":"object"},"classroom_v1_Registration":{"description":"An instruction to Classroom to send notifications from the `feed` to the provided destination.","type":"object","properties":{"cloudPubsubTopic":{"$ref":"#/components/schemas/classroom_v1_CloudPubsubTopic"},"expiryTime":{"description":"The time until which the `Registration` is effective. This is a read-only field assigned by the server.","format":"google-datetime","type":"string"},"feed":{"$ref":"#/components/schemas/classroom_v1_Feed"},"registrationId":{"description":"A server-generated unique identifier for this `Registration`. Read-only.","type":"string"}}},"classroom_v1_ReturnStudentSubmissionRequest":{"description":"Request to return a student submission.","type":"object"},"classroom_v1_Rubric":{"description":"The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"courseWorkId":{"description":"Identifier for the course work this corresponds to. Read-only.","type":"string"},"creationTime":{"description":"Output only. Timestamp when this rubric was created. Read-only.","format":"google-datetime","readOnly":true,"type":"string"},"criteria":{"description":"List of criteria. Each criterion is a dimension on which performance is rated.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Criterion"}},"id":{"description":"Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.","type":"string"},"sourceSpreadsheetId":{"description":"Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.","type":"string"},"updateTime":{"description":"Output only. Timestamp of the most recent change to this rubric. Read-only.","format":"google-datetime","readOnly":true,"type":"string"}}},"classroom_v1_RubricGrade":{"description":"A rubric grade set for the student submission. There is at most one entry per rubric criterion.","type":"object","properties":{"criterionId":{"description":"Optional. Criterion ID.","type":"string"},"levelId":{"description":"Optional. Optional level ID of the selected level. If empty, no level was selected.","type":"string"},"points":{"description":"Optional. Optional points assigned for this criterion, typically based on the level. Levels might or might not have points. If unset, no points were set for this criterion.","format":"double","type":"number"}}},"classroom_v1_SharedDriveFile":{"description":"Drive file that is used as material for course work.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_DriveFile"},"shareMode":{"description":"Mechanism by which students access the Drive item.","enum":["UNKNOWN_SHARE_MODE","VIEW","EDIT","STUDENT_COPY"],"type":"string"}}},"classroom_v1_ShortAnswerSubmission":{"description":"Student work for a short answer question.","type":"object","properties":{"answer":{"description":"Student response to a short-answer question.","type":"string"}}},"classroom_v1_StateHistory":{"description":"The history of each state this submission has been in.","type":"object","properties":{"actorUserId":{"description":"The teacher or student who made the change.","type":"string"},"state":{"description":"The workflow pipeline stage.","enum":["STATE_UNSPECIFIED","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT","STUDENT_EDITED_AFTER_TURN_IN"],"type":"string"},"stateTimestamp":{"description":"When the submission entered this state.","format":"google-datetime","type":"string"}}},"classroom_v1_Student":{"description":"Student in a course.","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"profile":{"$ref":"#/components/schemas/classroom_v1_UserProfile"},"studentWorkFolder":{"$ref":"#/components/schemas/classroom_v1_DriveFolder"},"userId":{"description":"Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}}},"classroom_v1_StudentContext":{"description":"Role-specific context if the requesting user is a student.","type":"object","properties":{"submissionId":{"description":"Requesting user's submission id to be used for grade passback and to identify the student when showing student work to the teacher. This is set exactly when `supportsStudentWork` is `true`.","type":"string"}}},"classroom_v1_StudentGroup":{"description":"A student group in a course.","type":"object","properties":{"courseId":{"description":"The identifier of the course.","type":"string"},"id":{"description":"The identifier of the student group.","type":"string"},"title":{"description":"The title of the student group.","type":"string"}}},"classroom_v1_StudentGroupMember":{"description":"A student member in a student group.","type":"object","properties":{"courseId":{"description":"The identifier of the course.","type":"string"},"studentGroupId":{"description":"The identifier of the student group.","type":"string"},"userId":{"description":"Identifier of the student.","type":"string"}}},"classroom_v1_StudentSubmission":{"description":"Student submission for course work. `StudentSubmission` items are generated when a `CourseWork` item is created. Student submissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.","type":"object","properties":{"alternateLink":{"description":"Absolute link to the submission in the Classroom web UI. Read-only.","type":"string"},"assignedGrade":{"description":"Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers.","format":"double","type":"number"},"assignedRubricGrades":{"description":"Assigned rubric grades based on the rubric's Criteria. This map is empty if there is no rubric attached to this course work or if a rubric is attached, but no grades have been set on any Criteria. Entries are only populated for grades that have been set. Key: The rubric's criterion ID. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/classroom_v1_RubricGrade"}},"assignmentSubmission":{"$ref":"#/components/schemas/classroom_v1_AssignmentSubmission"},"associatedWithDeveloper":{"description":"Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.","type":"boolean"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"courseWorkId":{"description":"Identifier for the course work this corresponds to. Read-only.","type":"string"},"courseWorkType":{"description":"Type of course work this submission is for. Read-only.","enum":["COURSE_WORK_TYPE_UNSPECIFIED","ASSIGNMENT","SHORT_ANSWER_QUESTION","MULTIPLE_CHOICE_QUESTION"],"type":"string"},"creationTime":{"description":"Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.","format":"google-datetime","type":"string"},"draftGrade":{"description":"Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers.","format":"double","type":"number"},"draftRubricGrades":{"description":"Pending rubric grades based on the rubric's criteria. This map is empty if there is no rubric attached to this course work or if a rubric is attached, but no grades have been set on any criteria. Entries are only populated for grades that have been set. Key: The rubric's criterion ID. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/classroom_v1_RubricGrade"}},"id":{"description":"Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.","type":"string"},"late":{"description":"Whether this submission is late. Read-only.","type":"boolean"},"multipleChoiceSubmission":{"$ref":"#/components/schemas/classroom_v1_MultipleChoiceSubmission"},"shortAnswerSubmission":{"$ref":"#/components/schemas/classroom_v1_ShortAnswerSubmission"},"state":{"description":"State of this submission. Read-only.","enum":["SUBMISSION_STATE_UNSPECIFIED","NEW","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT"],"type":"string"},"submissionHistory":{"description":"The history of the submission (includes state and grade histories). Read-only.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_SubmissionHistory"}},"updateTime":{"description":"Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.","format":"google-datetime","type":"string"},"userId":{"description":"Identifier for the student that owns this submission. Read-only.","type":"string"}}},"classroom_v1_SubmissionHistory":{"description":"The history of the submission. This currently includes state and grade histories.","type":"object","properties":{"gradeHistory":{"$ref":"#/components/schemas/classroom_v1_GradeHistory"},"stateHistory":{"$ref":"#/components/schemas/classroom_v1_StateHistory"}}},"classroom_v1_Teacher":{"description":"Teacher of a course.","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"profile":{"$ref":"#/components/schemas/classroom_v1_UserProfile"},"userId":{"description":"Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}}},"classroom_v1_TeacherContext":{"description":"Role-specific context if the requesting user is a teacher.","type":"object"},"classroom_v1_TimeOfDay":{"description":"Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.","type":"object","properties":{"hours":{"description":"Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.","format":"int32","type":"integer"},"minutes":{"description":"Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.","format":"int32","type":"integer"},"nanos":{"description":"Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.","format":"int32","type":"integer"},"seconds":{"description":"Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.","format":"int32","type":"integer"}}},"classroom_v1_Topic":{"description":"Topic created by a teacher for the course","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"name":{"description":"The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.","type":"string"},"topicId":{"description":"Unique identifier for the topic. Read-only.","type":"string"},"updateTime":{"description":"The time the topic was last updated by the system. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_TurnInStudentSubmissionRequest":{"description":"Request to turn in a student submission.","type":"object"},"classroom_v1_UserProfile":{"description":"Global information for a user.","type":"object","properties":{"emailAddress":{"description":"Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.","type":"string"},"id":{"description":"Identifier of the user. Read-only.","type":"string"},"name":{"$ref":"#/components/schemas/classroom_v1_Name"},"permissions":{"description":"Global permissions of the user. Read-only.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GlobalPermission"}},"photoUrl":{"description":"URL of user's profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.","type":"string"},"verifiedTeacher":{"description":"Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only","type":"boolean"}}},"classroom_v1_YouTubeVideo":{"description":"YouTube video item.","type":"object","properties":{"alternateLink":{"description":"URL that can be used to view the YouTube video. Read-only.","type":"string"},"id":{"description":"YouTube API resource ID.","type":"string"},"thumbnailUrl":{"description":"URL of a thumbnail image of the YouTube video. Read-only.","type":"string"},"title":{"description":"Title of the YouTube video. Read-only.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/classroom.announcements":"","https://www.googleapis.com/auth/classroom.courses":"","https://www.googleapis.com/auth/classroom.coursework.me":"","https://www.googleapis.com/auth/classroom.coursework.students":"","https://www.googleapis.com/auth/classroom.courseworkmaterials":"","https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly":"","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly":"","https://www.googleapis.com/auth/classroom.profile.emails":"","https://www.googleapis.com/auth/classroom.profile.photos":"","https://www.googleapis.com/auth/classroom.rosters":"","https://www.googleapis.com/auth/classroom.topics":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/classroom.announcements","https://www.googleapis.com/auth/classroom.courses","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students","https://www.googleapis.com/auth/classroom.courseworkmaterials","https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly","https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters","https://www.googleapis.com/auth/classroom.topics"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/classroom/v1/rest","service":"classroom","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Classroom API","version":"v1","description":"Manages classes, rosters, and invitations in Google Classroom."},"servers":[{"url":"https://classroom.googleapis.com/"}],"paths":{"/v1/courses":{"get":{"operationId":"classroom.courses.list","x-executor-toolPath":"classroom.courses.list","tags":["Google Classroom API"],"description":"Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseStates","in":"query","required":false,"description":"Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.","schema":{"type":"array","items":{"description":"Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.","enum":["COURSE_STATE_UNSPECIFIED","ACTIVE","ARCHIVED","PROVISIONED","DECLINED","SUSPENDED"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"studentId","in":"query","required":false,"description":"Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `teacher_id` must be empty.","schema":{"description":"Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `teacher_id` must be empty.","type":"string"},"style":"form","explode":false},{"name":"teacherId","in":"query","required":false,"description":"Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `student_id` must be empty.","schema":{"description":"Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `student_id` must be empty.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCoursesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses.readonly","https://www.googleapis.com/auth/classroom.courses"]},"post":{"operationId":"classroom.courses.create","x-executor-toolPath":"classroom.courses.create","tags":["Google Classroom API"],"description":"Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * CourseTitleCannotContainUrl * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/aliases":{"get":{"operationId":"classroom.courses.aliases.list","x-executor-toolPath":"classroom.courses.aliases.list","tags":["Google Classroom API"],"description":"Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCourseAliasesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses.readonly","https://www.googleapis.com/auth/classroom.courses"]},"post":{"operationId":"classroom.courses.aliases.create","x-executor-toolPath":"classroom.courses.aliases.create","tags":["Google Classroom API"],"description":"Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseAlias"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseAlias"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/aliases/{alias}":{"delete":{"operationId":"classroom.courses.aliases.delete","x-executor-toolPath":"classroom.courses.aliases.delete","tags":["Google Classroom API"],"description":"Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"alias","in":"path","required":true,"description":"Alias to delete. This may not be the Classroom-assigned identifier.","schema":{"description":"Alias to delete. This may not be the Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/announcements":{"get":{"operationId":"classroom.courses.announcements.list","x-executor-toolPath":"classroom.courses.announcements.list","tags":["Google Classroom API"],"description":"Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"announcementStates","in":"query","required":false,"description":"Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.","schema":{"type":"array","items":{"description":"Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.","enum":["ANNOUNCEMENT_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"}},"style":"form","explode":true},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","schema":{"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListAnnouncementsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements.readonly","https://www.googleapis.com/auth/classroom.announcements"]},"post":{"operationId":"classroom.courses.announcements.create","x-executor-toolPath":"classroom.courses.announcements.create","tags":["Google Classroom API"],"description":"Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]}},"/v1/courses/{courseId}/announcements/{id}":{"get":{"operationId":"classroom.courses.announcements.get","x-executor-toolPath":"classroom.courses.announcements.get","tags":["Google Classroom API"],"description":"Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement.","schema":{"description":"Identifier of the announcement.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements.readonly","https://www.googleapis.com/auth/classroom.announcements"]},"delete":{"operationId":"classroom.courses.announcements.delete","x-executor-toolPath":"classroom.courses.announcements.delete","tags":["Google Classroom API"],"description":"Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.","schema":{"description":"Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]},"patch":{"operationId":"classroom.courses.announcements.patch","x-executor-toolPath":"classroom.courses.announcements.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement.","schema":{"description":"Identifier of the announcement.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`","schema":{"description":"Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]}},"/v1/courses/{courseId}/announcements/{id}:modifyAssignees":{"post":{"operationId":"classroom.courses.announcements.modifyAssignees","x-executor-toolPath":"classroom.courses.announcements.modifyAssignees","tags":["Google Classroom API"],"description":"Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the announcement.","schema":{"description":"Identifier of the announcement.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ModifyAnnouncementAssigneesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Announcement"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.announcements"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.announcements"]}},"/v1/courses/{courseId}/courseWork":{"get":{"operationId":"classroom.courses.courseWork.list","x-executor-toolPath":"classroom.courses.courseWork.list","tags":["Google Classroom API"],"description":"Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseWorkStates","in":"query","required":false,"description":"Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","schema":{"type":"array","items":{"description":"Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","enum":["COURSE_WORK_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`","schema":{"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCourseWorkResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me.readonly","https://www.googleapis.com/auth/classroom.coursework.students.readonly","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"post":{"operationId":"classroom.courses.courseWork.create","x-executor-toolPath":"classroom.courses.courseWork.create","tags":["Google Classroom API"],"description":"Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/rubric":{"patch":{"operationId":"classroom.courses.courseWork.updateRubric","x-executor-toolPath":"classroom.courses.courseWork.updateRubric","tags":["Google Classroom API"],"description":"Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Optional. Identifier of the rubric.","schema":{"description":"Optional. Identifier of the rubric.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","schema":{"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics":{"get":{"operationId":"classroom.courses.courseWork.rubrics.list","x-executor-toolPath":"classroom.courses.courseWork.rubrics.list","tags":["Google Classroom API"],"description":"Returns a list of rubrics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work doesn't exist or if the user doesn't have access to the corresponding course work.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1.","schema":{"description":"The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListRubricsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me.readonly","https://www.googleapis.com/auth/classroom.coursework.students.readonly","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"post":{"operationId":"classroom.courses.courseWork.rubrics.create","x-executor-toolPath":"classroom.courses.courseWork.rubrics.create","tags":["Google Classroom API"],"description":"Creates a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}":{"get":{"operationId":"classroom.courses.courseWork.rubrics.get","x-executor-toolPath":"classroom.courses.courseWork.rubrics.get","tags":["Google Classroom API"],"description":"Returns a rubric. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Required. Identifier of the rubric.","schema":{"description":"Required. Identifier of the rubric.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me.readonly","https://www.googleapis.com/auth/classroom.coursework.students.readonly","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"delete":{"operationId":"classroom.courses.courseWork.rubrics.delete","x-executor-toolPath":"classroom.courses.courseWork.rubrics.delete","tags":["Google Classroom API"],"description":"Deletes a rubric. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Required. Identifier of the rubric.","schema":{"description":"Required. Identifier of the rubric.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]},"patch":{"operationId":"classroom.courses.courseWork.rubrics.patch","x-executor-toolPath":"classroom.courses.courseWork.rubrics.patch","tags":["Google Classroom API"],"description":"Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. The requesting user and course owner must have rubrics creation capabilities. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/rubrics/limitations#license-requirements). This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. Identifier of the course.","schema":{"description":"Required. Identifier of the course.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Required. Identifier of the course work.","schema":{"description":"Required. Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Optional. Identifier of the rubric.","schema":{"description":"Optional. Identifier of the rubric.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","schema":{"description":"Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions":{"get":{"operationId":"classroom.courses.courseWork.studentSubmissions.list","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.list","tags":["Google Classroom API"],"description":"Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. A hyphen (`-`) may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the student work to request. This may be set to the string literal `\"-\"` to request student work for all course work in the specified course.","schema":{"description":"Identifier of the student work to request. This may be set to the string literal `\"-\"` to request student work for all course work in the specified course.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"late","in":"query","required":false,"description":"Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.","schema":{"description":"Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.","enum":["LATE_VALUES_UNSPECIFIED","LATE_ONLY","NOT_LATE_ONLY"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"states","in":"query","required":false,"description":"Requested submission states. If specified, returned student submissions match one of the specified submission states.","schema":{"type":"array","items":{"description":"Requested submission states. If specified, returned student submissions match one of the specified submission states.","enum":["SUBMISSION_STATE_UNSPECIFIED","NEW","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userId","in":"query","required":false,"description":"Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListStudentSubmissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me.readonly","https://www.googleapis.com/auth/classroom.coursework.students.readonly","https://www.googleapis.com/auth/classroom.student-submissions.me.readonly","https://www.googleapis.com/auth/classroom.student-submissions.students.readonly","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}":{"get":{"operationId":"classroom.courses.courseWork.studentSubmissions.get","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.get","tags":["Google Classroom API"],"description":"Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me.readonly","https://www.googleapis.com/auth/classroom.coursework.students.readonly","https://www.googleapis.com/auth/classroom.student-submissions.me.readonly","https://www.googleapis.com/auth/classroom.student-submissions.students.readonly","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"patch":{"operationId":"classroom.courses.courseWork.studentSubmissions.patch","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment with Grade Sync enabled on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work or an add-on attachment on the corresponding course work with Grade Sync enabled, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`","schema":{"description":"Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.modifyAttachments","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.modifyAttachments","tags":["Google Classroom API"],"description":"Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ModifyAttachmentsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.reclaim","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.reclaim","tags":["Google Classroom API"],"description":"Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ReclaimStudentSubmissionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.return","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.return","tags":["Google Classroom API"],"description":"Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ReturnStudentSubmissionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn":{"post":{"operationId":"classroom.courses.courseWork.studentSubmissions.turnIn","x-executor-toolPath":"classroom.courses.courseWork.studentSubmissions.turnIn","tags":["Google Classroom API"],"description":"Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"courseWorkId","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the student submission.","schema":{"description":"Identifier of the student submission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_TurnInStudentSubmissionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me"]}},"/v1/courses/{courseId}/courseWork/{id}":{"get":{"operationId":"classroom.courses.courseWork.get","x-executor-toolPath":"classroom.courses.courseWork.get","tags":["Google Classroom API"],"description":"Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.me"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.me.readonly","https://www.googleapis.com/auth/classroom.coursework.students.readonly","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students"]},"delete":{"operationId":"classroom.courses.courseWork.delete","x-executor-toolPath":"classroom.courses.courseWork.delete","tags":["Google Classroom API"],"description":"Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.","schema":{"description":"Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]},"patch":{"operationId":"classroom.courses.courseWork.patch","x-executor-toolPath":"classroom.courses.courseWork.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work or an add-on attachment on the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work.","schema":{"description":"Identifier of the course work.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` * `learning_goals`","schema":{"description":"Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` * `learning_goals`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWork/{id}:modifyAssignees":{"post":{"operationId":"classroom.courses.courseWork.modifyAssignees","x-executor-toolPath":"classroom.courses.courseWork.modifyAssignees","tags":["Google Classroom API"],"description":"Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * `FAILED_PRECONDITION` for the following request error: * EmptyAssignees","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the coursework.","schema":{"description":"Identifier of the coursework.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ModifyCourseWorkAssigneesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.coursework.students"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.coursework.students"]}},"/v1/courses/{courseId}/courseWorkMaterials":{"get":{"operationId":"classroom.courses.courseWorkMaterials.list","x-executor-toolPath":"classroom.courses.courseWorkMaterials.list","tags":["Google Classroom API"],"description":"Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseWorkMaterialStates","in":"query","required":false,"description":"Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","schema":{"type":"array","items":{"description":"Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.","enum":["COURSEWORK_MATERIAL_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"}},"style":"form","explode":true},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"materialDriveId","in":"query","required":false,"description":"Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `material_link` is also specified, course work material must have materials matching both filters.","schema":{"description":"Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `material_link` is also specified, course work material must have materials matching both filters.","type":"string"},"style":"form","explode":false},{"name":"materialLink","in":"query","required":false,"description":"Optional filtering for course work material with at least one link material whose URL partially matches the provided string.","schema":{"description":"Optional filtering for course work material with at least one link material whose URL partially matches the provided string.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","schema":{"description":"Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListCourseWorkMaterialResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly","https://www.googleapis.com/auth/classroom.courseworkmaterials"]},"post":{"operationId":"classroom.courses.courseWorkMaterials.create","x-executor-toolPath":"classroom.courses.courseWorkMaterials.create","tags":["Google Classroom API"],"description":"Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}},"/v1/courses/{courseId}/courseWorkMaterials/{id}":{"get":{"operationId":"classroom.courses.courseWorkMaterials.get","x-executor-toolPath":"classroom.courses.courseWorkMaterials.get","tags":["Google Classroom API"],"description":"Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work material.","schema":{"description":"Identifier of the course work material.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly","https://www.googleapis.com/auth/classroom.courseworkmaterials"]},"delete":{"operationId":"classroom.courses.courseWorkMaterials.delete","x-executor-toolPath":"classroom.courses.courseWorkMaterials.delete","tags":["Google Classroom API"],"description":"Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.","schema":{"description":"Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]},"patch":{"operationId":"classroom.courses.courseWorkMaterials.patch","x-executor-toolPath":"classroom.courses.courseWorkMaterials.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the course work material.","schema":{"description":"Identifier of the course work material.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` * `learning_goals`","schema":{"description":"Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` * `learning_goals`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courseworkmaterials"]}},"/v1/courses/{courseId}/gradingPeriodSettings":{"get":{"operationId":"classroom.courses.getGradingPeriodSettings","x-executor-toolPath":"classroom.courses.getGradingPeriodSettings","tags":["Google Classroom API"],"description":"Returns the grading period settings in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. The identifier of the course.","schema":{"description":"Required. The identifier of the course.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GradingPeriodSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses.readonly","https://www.googleapis.com/auth/classroom.courses"]},"patch":{"operationId":"classroom.courses.updateGradingPeriodSettings","x-executor-toolPath":"classroom.courses.updateGradingPeriodSettings","tags":["Google Classroom API"],"description":"Updates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course owner must be eligible to modify Grading Periods. For details, see [licensing requirements](https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for access errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Required. The identifier of the course.","schema":{"description":"Required. The identifier of the course.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework`","schema":{"description":"Mask that identifies which fields in the GradingPeriodSettings to update. The GradingPeriodSettings `grading_periods` list will be fully replaced by the grading periods specified in the update request. For example: * Grading periods included in the list without an ID are considered additions, and a new ID will be assigned when the request is made. * Grading periods that currently exist, but are missing from the request will be considered deletions. * Grading periods with an existing ID and modified data are considered edits. Unmodified data will be left as is. * Grading periods included with an unknown ID will result in an error. The following fields may be specified: * `grading_periods` * `apply_to_existing_coursework`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GradingPeriodSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GradingPeriodSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/courses/{courseId}/students":{"get":{"operationId":"classroom.courses.students.list","x-executor-toolPath":"classroom.courses.students.list","tags":["Google Classroom API"],"description":"Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListStudentsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters.readonly","https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]},"post":{"operationId":"classroom.courses.students.create","x-executor-toolPath":"classroom.courses.students.create","tags":["Google Classroom API"],"description":"Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enrollmentCode","in":"query","required":false,"description":"Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.","schema":{"description":"Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Student"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Student"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/students/{userId}":{"get":{"operationId":"classroom.courses.students.get","x-executor-toolPath":"classroom.courses.students.get","tags":["Google Classroom API"],"description":"Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Student"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters.readonly","https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]},"delete":{"operationId":"classroom.courses.students.delete","x-executor-toolPath":"classroom.courses.students.delete","tags":["Google Classroom API"],"description":"Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/teachers":{"get":{"operationId":"classroom.courses.teachers.list","x-executor-toolPath":"classroom.courses.teachers.list","tags":["Google Classroom API"],"description":"Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListTeachersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters.readonly","https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/teachers/{userId}":{"get":{"operationId":"classroom.courses.teachers.get","x-executor-toolPath":"classroom.courses.teachers.get","tags":["Google Classroom API"],"description":"Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Teacher"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters.readonly","https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]},"delete":{"operationId":"classroom.courses.teachers.delete","x-executor-toolPath":"classroom.courses.teachers.delete","tags":["Google Classroom API"],"description":"Removes the specified teacher from the specified course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"userId","in":"path","required":true,"description":"Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/courses/{courseId}/topics":{"get":{"operationId":"classroom.courses.topics.list","x-executor-toolPath":"classroom.courses.topics.list","tags":["Google Classroom API"],"description":"Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListTopicResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics.readonly","https://www.googleapis.com/auth/classroom.topics"]},"post":{"operationId":"classroom.courses.topics.create","x-executor-toolPath":"classroom.courses.topics.create","tags":["Google Classroom API"],"description":"Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `FAILED_PRECONDITION` for the following request error: * CourseTopicLimitReached * `NOT_FOUND` if the requested course does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]}},"/v1/courses/{courseId}/topics/{id}":{"get":{"operationId":"classroom.courses.topics.get","x-executor-toolPath":"classroom.courses.topics.get","tags":["Google Classroom API"],"description":"Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course.","schema":{"description":"Identifier of the course.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the topic.","schema":{"description":"Identifier of the topic.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics.readonly","https://www.googleapis.com/auth/classroom.topics"]},"delete":{"operationId":"classroom.courses.topics.delete","x-executor-toolPath":"classroom.courses.topics.delete","tags":["Google Classroom API"],"description":"Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the topic to delete.","schema":{"description":"Identifier of the topic to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]},"patch":{"operationId":"classroom.courses.topics.patch","x-executor-toolPath":"classroom.courses.topics.patch","tags":["Google Classroom API"],"description":"Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course or topic does not exist","parameters":[{"name":"courseId","in":"path","required":true,"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the topic.","schema":{"description":"Identifier of the topic.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name`","schema":{"description":"Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.topics"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.topics"]}},"/v1/courses/{id}":{"get":{"operationId":"classroom.courses.get","x-executor-toolPath":"classroom.courses.get","tags":["Google Classroom API"],"description":"Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses.readonly","https://www.googleapis.com/auth/classroom.courses"]},"put":{"operationId":"classroom.courses.update","x-executor-toolPath":"classroom.courses.update","tags":["Google Classroom API"],"description":"Updates a course. Note: Unlike other fields, `levels` is not cleared if omitted from the request. The `UpdateCourse` method only modifies `levels` if it is explicitly provided; otherwise, the existing value is preserved. Use the `PatchCourse` method to clear the `levels` field. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrl","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"delete":{"operationId":"classroom.courses.delete","x-executor-toolPath":"classroom.courses.delete","tags":["Google Classroom API"],"description":"Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]},"patch":{"operationId":"classroom.courses.patch","x-executor-toolPath":"classroom.courses.patch","tags":["Google Classroom API"],"description":"Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * InactiveCourseOwner * IneligibleOwner * CourseTitleCannotContainUrl","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","schema":{"description":"Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `learningStandardSettings` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`","schema":{"description":"Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `courseState` * `description` * `descriptionHeading` * `name` * `ownerId` * `room` * `section` * `subject` * `learningStandardSettings` * `levels` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Course"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.courses"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.courses"]}},"/v1/invitations":{"get":{"operationId":"classroom.invitations.list","x-executor-toolPath":"classroom.invitations.list","tags":["Google Classroom API"],"description":"Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"courseId","in":"query","required":false,"description":"Restricts returned invitations to those for a course with the specified identifier.","schema":{"description":"Restricts returned invitations to those for a course with the specified identifier.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"userId","in":"query","required":false,"description":"Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListInvitationsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters.readonly","https://www.googleapis.com/auth/classroom.rosters"]},"post":{"operationId":"classroom.invitations.create","x-executor-toolPath":"classroom.invitations.create","tags":["Google Classroom API"],"description":"Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION`: * if the requested user's account is disabled. * if the user already has this role or a role with greater permissions. * for the following request errors: * IneligibleOwner * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Invitation"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Invitation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/invitations/{id}":{"get":{"operationId":"classroom.invitations.get","x-executor-toolPath":"classroom.invitations.get","tags":["Google Classroom API"],"description":"Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the invitation to return.","schema":{"description":"Identifier of the invitation to return.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Invitation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters.readonly","https://www.googleapis.com/auth/classroom.rosters"]},"delete":{"operationId":"classroom.invitations.delete","x-executor-toolPath":"classroom.invitations.delete","tags":["Google Classroom API"],"description":"Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the invitation to delete.","schema":{"description":"Identifier of the invitation to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/invitations/{id}:accept":{"post":{"operationId":"classroom.invitations.accept","x-executor-toolPath":"classroom.invitations.accept","tags":["Google Classroom API"],"description":"Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the invitation to accept.","schema":{"description":"Identifier of the invitation to accept.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters"]}},"/v1/userProfiles/{studentId}/guardianInvitations":{"get":{"operationId":"classroom.userProfiles.guardianInvitations.list","x-executor-toolPath":"classroom.userProfiles.guardianInvitations.list","tags":["Google Classroom API"],"description":"Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.","parameters":[{"name":"studentId","in":"path","required":true,"description":"The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.","schema":{"description":"The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"invitedEmailAddress","in":"query","required":false,"description":"If specified, only results with the specified `invited_email_address` are returned.","schema":{"description":"If specified, only results with the specified `invited_email_address` are returned.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"states","in":"query","required":false,"description":"If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned.","schema":{"type":"array","items":{"description":"If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned.","enum":["GUARDIAN_INVITATION_STATE_UNSPECIFIED","PENDING","COMPLETE"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListGuardianInvitationsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}":{"get":{"operationId":"classroom.userProfiles.guardianInvitations.get","x-executor-toolPath":"classroom.userProfiles.guardianInvitations.get","tags":["Google Classroom API"],"description":"Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.","parameters":[{"name":"studentId","in":"path","required":true,"description":"The ID of the student whose guardian invitation is being requested.","schema":{"description":"The ID of the student whose guardian invitation is being requested.","type":"string"}},{"name":"invitationId","in":"path","required":true,"description":"The `id` field of the `GuardianInvitation` being requested.","schema":{"description":"The `id` field of the `GuardianInvitation` being requested.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_GuardianInvitation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{studentId}/guardians":{"get":{"operationId":"classroom.userProfiles.guardians.list","x-executor-toolPath":"classroom.userProfiles.guardians.list","tags":["Google Classroom API"],"description":"Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.","parameters":[{"name":"studentId","in":"path","required":true,"description":"Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.","schema":{"description":"Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"invitedEmailAddress","in":"query","required":false,"description":"Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.","schema":{"description":"Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","schema":{"description":"Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","schema":{"description":"nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_ListGuardiansResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{studentId}/guardians/{guardianId}":{"get":{"operationId":"classroom.userProfiles.guardians.get","x-executor-toolPath":"classroom.userProfiles.guardians.get","tags":["Google Classroom API"],"description":"Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.","parameters":[{"name":"studentId","in":"path","required":true,"description":"The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"guardianId","in":"path","required":true,"description":"The `id` field from a `Guardian`.","schema":{"description":"The `id` field from a `Guardian`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_Guardian"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]}},"/v1/userProfiles/{userId}":{"get":{"operationId":"classroom.userProfiles.get","x-executor-toolPath":"classroom.userProfiles.get","tags":["Google Classroom API"],"description":"Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.","parameters":[{"name":"userId","in":"path","required":true,"description":"Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","schema":{"description":"Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/classroom_v1_UserProfile"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.emails"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.profile.photos"]},{"googleOAuth2":["https://www.googleapis.com/auth/classroom.rosters"]}],"x-google-scopes":["https://www.googleapis.com/auth/classroom.rosters.readonly","https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters"]}}},"components":{"schemas":{"classroom_v1_AddOnAttachment":{"description":"An add-on attachment on a post.","type":"object","properties":{"copyHistory":{"description":"Output only. Identifiers of attachments that were previous copies of this attachment. If the attachment was previously copied by virtue of its parent post being copied, this enumerates the identifiers of attachments that were its previous copies in ascending chronological order of copy.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CopyHistory"}},"courseId":{"description":"Immutable. Identifier of the course.","type":"string"},"dueDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"dueTime":{"$ref":"#/components/schemas/classroom_v1_TimeOfDay"},"id":{"description":"Immutable. Classroom-assigned identifier for this attachment, unique per post.","type":"string"},"itemId":{"description":"Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. Unique per course.","type":"string"},"maxPoints":{"description":"Maximum grade for this attachment. Can only be set if `studentWorkReviewUri` is set. Set to a non-zero value to indicate that the attachment supports grade passback. If set, this must be a non-negative integer value. When set to zero, the attachment will not support grade passback.","format":"double","type":"number"},"postId":{"description":"Immutable. Deprecated, use `item_id` instead.","type":"string"},"studentViewUri":{"$ref":"#/components/schemas/classroom_v1_EmbedUri"},"studentWorkReviewUri":{"$ref":"#/components/schemas/classroom_v1_EmbedUri"},"teacherViewUri":{"$ref":"#/components/schemas/classroom_v1_EmbedUri"},"title":{"description":"Required. Title of this attachment. The title must be between 1 and 1000 characters.","type":"string"}}},"classroom_v1_AddOnAttachmentStudentSubmission":{"description":"Payload for grade update requests.","type":"object","properties":{"courseWorkSubmissionId":{"description":"Output only. Identifier of the course work submission under which this attachment submission was made.","readOnly":true,"type":"string"},"id":{"description":"Output only. Classroom-assigned identifier for this student submission. This is unique among submissions for the relevant course work and add-on attachment combination.","readOnly":true,"type":"string"},"pointsEarned":{"description":"Student grade on this attachment. If unset, no grade was set.","format":"double","type":"number"},"postSubmissionState":{"description":"Submission state of add-on attachment's parent post (i.e. assignment).","enum":["SUBMISSION_STATE_UNSPECIFIED","NEW","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT"],"type":"string"},"userId":{"description":"Identifier for the student that owns this submission. Requires the user to be a teacher in the course and have permission to read student submissions. See [`courseWork.studentSubmissions.get`](/workspace/classroom/reference/rest/v1/courses.courseWork.studentSubmissions/get#authorization-scopes) for the list of acceptable OAuth scopes for this field. Read-only.","type":"string"}}},"classroom_v1_AddOnContext":{"description":"Attachment-relevant metadata for Classroom add-ons in the context of a specific post.","type":"object","properties":{"courseId":{"description":"Immutable. Identifier of the course.","type":"string"},"itemId":{"description":"Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.","type":"string"},"postId":{"description":"Immutable. Deprecated, use `item_id` instead.","type":"string"},"studentContext":{"$ref":"#/components/schemas/classroom_v1_StudentContext"},"supportsStudentWork":{"description":"Optional. Whether the post allows the teacher to see student work and passback grades.","type":"boolean"},"teacherContext":{"$ref":"#/components/schemas/classroom_v1_TeacherContext"}}},"classroom_v1_Announcement":{"description":"Announcement created by a teacher for students of the course","type":"object","properties":{"alternateLink":{"description":"Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.","type":"string"},"assigneeMode":{"description":"Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"creationTime":{"description":"Timestamp when this announcement was created. Read-only.","format":"google-datetime","type":"string"},"creatorUserId":{"description":"Identifier for the user that created the announcement. Read-only.","type":"string"},"id":{"description":"Classroom-assigned identifier of this announcement, unique per course. Read-only.","type":"string"},"individualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_IndividualStudentsOptions"},"materials":{"description":"Additional materials. Announcements must have no more than 20 material items.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Material"}},"scheduledTime":{"description":"Optional timestamp when this announcement is scheduled to be published.","format":"google-datetime","type":"string"},"state":{"description":"Status of this announcement. If unspecified, the default state is `DRAFT`.","enum":["ANNOUNCEMENT_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"},"text":{"description":"Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.","type":"string"},"updateTime":{"description":"Timestamp of the most recent change to this announcement. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_Assignment":{"description":"Additional details for assignments.","type":"object","properties":{"studentWorkFolder":{"$ref":"#/components/schemas/classroom_v1_DriveFolder"}}},"classroom_v1_AssignmentSubmission":{"description":"Student work for an assignment.","type":"object","properties":{"attachments":{"description":"Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Attachment"}}}},"classroom_v1_Attachment":{"description":"Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_DriveFile"},"form":{"$ref":"#/components/schemas/classroom_v1_Form"},"link":{"$ref":"#/components/schemas/classroom_v1_Link"},"youTubeVideo":{"$ref":"#/components/schemas/classroom_v1_YouTubeVideo"}}},"classroom_v1_CloudPubsubTopic":{"description":"A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.","type":"object","properties":{"topicName":{"description":"The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).","type":"string"}}},"classroom_v1_CopyHistory":{"description":"Identifier of a previous copy of a given attachment.","type":"object","properties":{"attachmentId":{"description":"Immutable. Identifier of the attachment.","type":"string"},"courseId":{"description":"Immutable. Identifier of the course.","type":"string"},"itemId":{"description":"Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.","type":"string"},"postId":{"description":"Immutable. Deprecated, use `item_id` instead.","type":"string"}}},"classroom_v1_Course":{"description":"A Course in Classroom.","type":"object","properties":{"alternateLink":{"description":"Absolute link to this course in the Classroom web UI. Read-only.","type":"string"},"calendarId":{"description":"The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. The Calendar for a course is created asynchronously when the course is set to `CourseState.ACTIVE` for the first time (at creation time or when it is updated to `ACTIVE` through the UI or the API). The Calendar ID will not be populated until the creation process is completed. Read-only.","type":"string"},"courseGroupEmail":{"description":"The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.","type":"string"},"courseMaterialSets":{"description":"Sets of materials that appear on the \"about\" page of this course. Read-only.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseMaterialSet"}},"courseState":{"description":"State of the course. If unspecified, the default state is `PROVISIONED`.","enum":["COURSE_STATE_UNSPECIFIED","ACTIVE","ARCHIVED","PROVISIONED","DECLINED","SUSPENDED"],"type":"string"},"creationTime":{"description":"Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.","format":"google-datetime","type":"string"},"description":{"description":"Optional description. For example, \"We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!\" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.","type":"string"},"descriptionHeading":{"description":"Optional heading for the description. For example, \"Welcome to 10th Grade Biology.\" If set, this field must be a valid UTF-8 string and no longer than 3600 characters.","type":"string"},"enrollmentCode":{"description":"Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.","type":"string"},"gradebookSettings":{"$ref":"#/components/schemas/classroom_v1_GradebookSettings"},"guardiansEnabled":{"description":"Whether or not guardian notifications are enabled for this course. Read-only.","type":"boolean"},"id":{"description":"Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.","type":"string"},"levels":{"description":"Optional. Levels for the course. Examples: \"9th grade\", \"Middle school\", \"4th - 5th\", \"K-2\", \"3000\". If set, this field must be a valid UTF-8 string and fewer than 1000 characters. This field can only be cleared using the `PatchCourse` method.","type":"string"},"name":{"description":"Name of the course. For example, \"10th Grade Biology\". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.","type":"string"},"ownerId":{"description":"The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.","type":"string"},"room":{"description":"Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters.","type":"string"},"section":{"description":"Section of the course. For example, \"Period 2\". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.","type":"string"},"subject":{"description":"Optional. The subject of the course.","type":"string"},"teacherFolder":{"$ref":"#/components/schemas/classroom_v1_DriveFolder"},"teacherGroupEmail":{"description":"The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.","type":"string"},"updateTime":{"description":"Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_CourseAlias":{"description":"Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.","type":"object","properties":{"alias":{"description":"Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.","type":"string"}}},"classroom_v1_CourseMaterial":{"description":"A material attached to a course as part of a material set.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_DriveFile"},"form":{"$ref":"#/components/schemas/classroom_v1_Form"},"link":{"$ref":"#/components/schemas/classroom_v1_Link"},"youTubeVideo":{"$ref":"#/components/schemas/classroom_v1_YouTubeVideo"}}},"classroom_v1_CourseMaterialSet":{"description":"A set of materials that appears on the \"About\" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.","type":"object","properties":{"materials":{"description":"Materials attached to this set.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseMaterial"}},"title":{"description":"Title for this set.","type":"string"}}},"classroom_v1_CourseRosterChangesInfo":{"description":"Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.","type":"object","properties":{"courseId":{"description":"The `course_id` of the course to subscribe to roster changes for.","type":"string"}}},"classroom_v1_CourseWork":{"description":"Course work created by a teacher for students of the course.","type":"object","properties":{"alternateLink":{"description":"Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.","type":"string"},"assigneeMode":{"description":"Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"assignment":{"$ref":"#/components/schemas/classroom_v1_Assignment"},"associatedWithDeveloper":{"description":"Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.","type":"boolean"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"creationTime":{"description":"Timestamp when this course work was created. Read-only.","format":"google-datetime","type":"string"},"creatorUserId":{"description":"Identifier for the user that created the coursework. Read-only.","type":"string"},"description":{"description":"Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.","type":"string"},"dueDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"dueTime":{"$ref":"#/components/schemas/classroom_v1_TimeOfDay"},"gradeCategory":{"$ref":"#/components/schemas/classroom_v1_GradeCategory"},"gradingPeriodId":{"description":"Identifier of the grading period associated with the coursework. * At creation, if unspecified, the grading period ID will be set based on the `dueDate` (or `scheduledTime` if no `dueDate` is set). * To indicate no association to any grading period, set this field to an empty string (\"\"). * If specified, it must match an existing grading period ID in the course.","type":"string"},"id":{"description":"Classroom-assigned identifier of this course work, unique per course. Read-only.","type":"string"},"individualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_IndividualStudentsOptions"},"materials":{"description":"Additional materials. CourseWork must have no more than 20 material items.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Material"}},"maxPoints":{"description":"Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.","format":"double","type":"number"},"multipleChoiceQuestion":{"$ref":"#/components/schemas/classroom_v1_MultipleChoiceQuestion"},"scheduledTime":{"description":"Optional timestamp when this course work is scheduled to be published.","format":"google-datetime","type":"string"},"state":{"description":"Status of this course work. If unspecified, the default state is `DRAFT`.","enum":["COURSE_WORK_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"},"submissionModificationMode":{"description":"Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.","enum":["SUBMISSION_MODIFICATION_MODE_UNSPECIFIED","MODIFIABLE_UNTIL_TURNED_IN","MODIFIABLE"],"type":"string"},"title":{"description":"Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.","type":"string"},"topicId":{"description":"Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.","type":"string"},"updateTime":{"description":"Timestamp of the most recent change to this course work. Read-only.","format":"google-datetime","type":"string"},"workType":{"description":"Type of this course work. The type is set when the course work is created and cannot be changed.","enum":["COURSE_WORK_TYPE_UNSPECIFIED","ASSIGNMENT","SHORT_ANSWER_QUESTION","MULTIPLE_CHOICE_QUESTION"],"type":"string"}}},"classroom_v1_CourseWorkChangesInfo":{"description":"Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.","type":"object","properties":{"courseId":{"description":"The `course_id` of the course to subscribe to work changes for.","type":"string"}}},"classroom_v1_CourseWorkMaterial":{"description":"Course work material created by a teacher for students of the course","type":"object","properties":{"alternateLink":{"description":"Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.","type":"string"},"assigneeMode":{"description":"Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"creationTime":{"description":"Timestamp when this course work material was created. Read-only.","format":"google-datetime","type":"string"},"creatorUserId":{"description":"Identifier for the user that created the course work material. Read-only.","type":"string"},"description":{"description":"Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.","type":"string"},"id":{"description":"Classroom-assigned identifier of this course work material, unique per course. Read-only.","type":"string"},"individualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_IndividualStudentsOptions"},"materials":{"description":"Additional materials. A course work material must have no more than 20 material items.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Material"}},"scheduledTime":{"description":"Optional timestamp when this course work material is scheduled to be published.","format":"google-datetime","type":"string"},"state":{"description":"Status of this course work material. If unspecified, the default state is `DRAFT`.","enum":["COURSEWORK_MATERIAL_STATE_UNSPECIFIED","PUBLISHED","DRAFT","DELETED"],"type":"string"},"title":{"description":"Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.","type":"string"},"topicId":{"description":"Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.","type":"string"},"updateTime":{"description":"Timestamp of the most recent change to this course work material. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_Criterion":{"description":"A rubric criterion. Each criterion is a dimension on which performance is rated.","type":"object","properties":{"description":{"description":"The description of the criterion.","type":"string"},"id":{"description":"The criterion ID. On creation, an ID is assigned.","type":"string"},"levels":{"description":"The list of levels within this criterion.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Level"}},"title":{"description":"The title of the criterion.","type":"string"}}},"classroom_v1_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":{"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.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"classroom_v1_DriveFile":{"description":"Representation of a Google Drive file.","type":"object","properties":{"alternateLink":{"description":"URL that can be used to access the Drive item. Read-only.","type":"string"},"id":{"description":"Drive API resource ID.","type":"string"},"thumbnailUrl":{"description":"URL of a thumbnail image of the Drive item. Read-only.","type":"string"},"title":{"description":"Title of the Drive item. Read-only.","type":"string"}}},"classroom_v1_DriveFolder":{"description":"Representation of a Google Drive folder.","type":"object","properties":{"alternateLink":{"description":"URL that can be used to access the Drive folder. Read-only.","type":"string"},"id":{"description":"Drive API resource ID.","type":"string"},"title":{"description":"Title of the Drive folder. Read-only.","type":"string"}}},"classroom_v1_EmbedUri":{"description":"URI to be iframed after being populated with query parameters.","type":"object","properties":{"uri":{"description":"Required. URI to be iframed after being populated with query parameters. This must be a valid UTF-8 string containing between 1 and 1800 characters.","type":"string"}}},"classroom_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"classroom_v1_Feed":{"description":"A class of notifications that an application can register to receive. For example: \"all roster changes for a domain\".","type":"object","properties":{"courseRosterChangesInfo":{"$ref":"#/components/schemas/classroom_v1_CourseRosterChangesInfo"},"courseWorkChangesInfo":{"$ref":"#/components/schemas/classroom_v1_CourseWorkChangesInfo"},"feedType":{"description":"The type of feed.","enum":["FEED_TYPE_UNSPECIFIED","DOMAIN_ROSTER_CHANGES","COURSE_ROSTER_CHANGES","COURSE_WORK_CHANGES"],"type":"string"}}},"classroom_v1_Form":{"description":"Google Forms item.","type":"object","properties":{"formUrl":{"description":"URL of the form.","type":"string"},"responseUrl":{"description":"URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.","type":"string"},"thumbnailUrl":{"description":"URL of a thumbnail image of the Form. Read-only.","type":"string"},"title":{"description":"Title of the Form. Read-only.","type":"string"}}},"classroom_v1_GeminiGem":{"description":"Gemini Gem link.","type":"object","properties":{"id":{"description":"Gems resource id.","type":"string"},"title":{"description":"Title of the Gem.","type":"string"},"url":{"description":"URL that can be used to access the Gem.","type":"string"}}},"classroom_v1_GlobalPermission":{"description":"Global user permission description.","type":"object","properties":{"permission":{"description":"Permission value.","enum":["PERMISSION_UNSPECIFIED","CREATE_COURSE"],"type":"string"}}},"classroom_v1_GradeCategory":{"description":"Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.","type":"object","properties":{"defaultGradeDenominator":{"description":"Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS.","format":"int32","type":"integer"},"id":{"description":"ID of the grade category.","type":"string"},"name":{"description":"Name of the grade category.","type":"string"},"weight":{"description":"The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES.","format":"int32","type":"integer"}}},"classroom_v1_GradeHistory":{"description":"The history of each grade on this submission.","type":"object","properties":{"actorUserId":{"description":"The teacher who made the grade change.","type":"string"},"gradeChangeType":{"description":"The type of grade change at this time in the submission grade history.","enum":["UNKNOWN_GRADE_CHANGE_TYPE","DRAFT_GRADE_POINTS_EARNED_CHANGE","ASSIGNED_GRADE_POINTS_EARNED_CHANGE","MAX_POINTS_CHANGE"],"type":"string"},"gradeTimestamp":{"description":"When the grade of the submission was changed.","format":"google-datetime","type":"string"},"maxPoints":{"description":"The denominator of the grade at this time in the submission grade history.","format":"double","type":"number"},"pointsEarned":{"description":"The numerator of the grade at this time in the submission grade history.","format":"double","type":"number"}}},"classroom_v1_GradebookSettings":{"description":"The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.","type":"object","properties":{"calculationType":{"description":"Indicates how the overall grade is calculated.","enum":["CALCULATION_TYPE_UNSPECIFIED","TOTAL_POINTS","WEIGHTED_CATEGORIES"],"type":"string"},"displaySetting":{"description":"Indicates who can see the overall grade..","enum":["DISPLAY_SETTING_UNSPECIFIED","SHOW_OVERALL_GRADE","HIDE_OVERALL_GRADE","SHOW_TEACHERS_ONLY"],"type":"string"},"gradeCategories":{"description":"Grade categories that are available for coursework in the course.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GradeCategory"}}}},"classroom_v1_GradingPeriod":{"description":"An individual grading period. Grading periods must not have overlapping date ranges and must be listed in chronological order. For example, if the end_date of a grading period is 2024-01-25, then the start_date of the next grading period must be 2024-01-26 or later. Each grading period must have a unique title within a course.","type":"object","properties":{"endDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"id":{"description":"Output only. System generated grading period ID. Read-only.","readOnly":true,"type":"string"},"startDate":{"$ref":"#/components/schemas/classroom_v1_Date"},"title":{"description":"Required. Title of the grading period. For example, “Semester 1”.","type":"string"}}},"classroom_v1_GradingPeriodSettings":{"description":"Grading period settings that include all the individual grading periods in a course.","type":"object","properties":{"applyToExistingCoursework":{"description":"Supports toggling the application of grading periods on existing stream items. Once set, this value is persisted meaning that it does not need to be set in every request to update `GradingPeriodSettings`. If not previously set, the default is False.","type":"boolean"},"gradingPeriods":{"description":"The list of grading periods in a specific course. Grading periods must not have overlapping date ranges and must be listed in chronological order. Each grading period must have a unique title within a course.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GradingPeriod"}}}},"classroom_v1_Guardian":{"description":"Association between a student and a guardian of that student. The guardian may receive information about the student's course work.","type":"object","properties":{"guardianId":{"description":"Identifier for the guardian.","type":"string"},"guardianProfile":{"$ref":"#/components/schemas/classroom_v1_UserProfile"},"invitedEmailAddress":{"description":"The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.","type":"string"},"studentId":{"description":"Identifier for the student to whom the guardian relationship applies.","type":"string"}}},"classroom_v1_GuardianInvitation":{"description":"An invitation to become the guardian of a specified user, sent to a specified email address.","type":"object","properties":{"creationTime":{"description":"The time that this invitation was created. Read-only.","format":"google-datetime","type":"string"},"invitationId":{"description":"Unique identifier for this invitation. Read-only.","type":"string"},"invitedEmailAddress":{"description":"Email address that the invitation was sent to. This field is only visible to domain administrators.","type":"string"},"state":{"description":"The state that this invitation is in.","enum":["GUARDIAN_INVITATION_STATE_UNSPECIFIED","PENDING","COMPLETE"],"type":"string"},"studentId":{"description":"ID of the student (in standard format)","type":"string"}}},"classroom_v1_IndividualStudentsOptions":{"description":"Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.","type":"object","properties":{"studentIds":{"description":"Identifiers for the students that have access to the coursework/announcement.","type":"array","items":{"type":"string"}}}},"classroom_v1_Invitation":{"description":"An invitation to join a course.","type":"object","properties":{"courseId":{"description":"Identifier of the course to invite the user to.","type":"string"},"id":{"description":"Identifier assigned by Classroom. Read-only.","type":"string"},"role":{"description":"Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.","enum":["COURSE_ROLE_UNSPECIFIED","STUDENT","TEACHER","OWNER"],"type":"string"},"userId":{"description":"Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}}},"classroom_v1_Level":{"description":"A level of the criterion.","type":"object","properties":{"description":{"description":"The description of the level.","type":"string"},"id":{"description":"The level ID. On creation, an ID is assigned.","type":"string"},"points":{"description":"Optional points associated with this level. If set, all levels within the rubric must specify points and the value must be distinct across all levels within a single criterion. 0 is distinct from no points.","format":"double","type":"number"},"title":{"description":"The title of the level. If the level has no points set, title must be set.","type":"string"}}},"classroom_v1_Link":{"description":"URL item.","type":"object","properties":{"thumbnailUrl":{"description":"URL of a thumbnail image of the target URL. Read-only.","type":"string"},"title":{"description":"Title of the target of the URL. Read-only.","type":"string"},"url":{"description":"URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.","type":"string"}}},"classroom_v1_ListAddOnAttachmentsResponse":{"description":"Response when listing add-on attachments.","type":"object","properties":{"addOnAttachments":{"description":"Attachments under the given post.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_AddOnAttachment"}},"nextPageToken":{"description":"A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"}}},"classroom_v1_ListAnnouncementsResponse":{"description":"Response when listing course work.","type":"object","properties":{"announcements":{"description":"Announcement items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Announcement"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCourseAliasesResponse":{"description":"Response when listing course aliases.","type":"object","properties":{"aliases":{"description":"The course aliases.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseAlias"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCourseWorkMaterialResponse":{"description":"Response when listing course work material.","type":"object","properties":{"courseWorkMaterial":{"description":"Course work material items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseWorkMaterial"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCourseWorkResponse":{"description":"Response when listing course work.","type":"object","properties":{"courseWork":{"description":"Course work items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_CourseWork"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListCoursesResponse":{"description":"Response when listing courses.","type":"object","properties":{"courses":{"description":"Courses that match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Course"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListGuardianInvitationsResponse":{"description":"Response when listing guardian invitations.","type":"object","properties":{"guardianInvitations":{"description":"Guardian invitations that matched the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GuardianInvitation"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListGuardiansResponse":{"description":"Response when listing guardians.","type":"object","properties":{"guardians":{"description":"Guardians on this page of results that met the criteria specified in the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Guardian"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListInvitationsResponse":{"description":"Response when listing invitations.","type":"object","properties":{"invitations":{"description":"Invitations that match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Invitation"}},"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"}}},"classroom_v1_ListRubricsResponse":{"description":"Response when listing rubrics.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"rubrics":{"description":"Rubrics that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Rubric"}}}},"classroom_v1_ListStudentGroupMembersResponse":{"description":"Response when listing students in a group.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"studentGroupMembers":{"description":"The student group members.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_StudentGroupMember"}}}},"classroom_v1_ListStudentGroupsResponse":{"description":"Response when listing student groups.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"studentGroups":{"description":"The student groups.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_StudentGroup"}}}},"classroom_v1_ListStudentSubmissionsResponse":{"description":"Response when listing student submissions.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"studentSubmissions":{"description":"Student work that matches the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_StudentSubmission"}}}},"classroom_v1_ListStudentsResponse":{"description":"Response when listing students.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"students":{"description":"Students who match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Student"}}}},"classroom_v1_ListTeachersResponse":{"description":"Response when listing teachers.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"teachers":{"description":"Teachers who match the list request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Teacher"}}}},"classroom_v1_ListTopicResponse":{"description":"Response when listing topics.","type":"object","properties":{"nextPageToken":{"description":"Token identifying the next page of results to return. If empty, no further results are available.","type":"string"},"topic":{"description":"Topic items that match the request.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Topic"}}}},"classroom_v1_Material":{"description":"Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_SharedDriveFile"},"form":{"$ref":"#/components/schemas/classroom_v1_Form"},"gem":{"$ref":"#/components/schemas/classroom_v1_GeminiGem"},"link":{"$ref":"#/components/schemas/classroom_v1_Link"},"notebook":{"$ref":"#/components/schemas/classroom_v1_NotebookLmNotebook"},"youtubeVideo":{"$ref":"#/components/schemas/classroom_v1_YouTubeVideo"}}},"classroom_v1_ModifyAnnouncementAssigneesRequest":{"description":"Request to modify assignee mode and options of an announcement.","type":"object","properties":{"assigneeMode":{"description":"Mode of the announcement describing whether it is accessible by all students or specified individual students.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"modifyIndividualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_ModifyIndividualStudentsOptions"}}},"classroom_v1_ModifyAttachmentsRequest":{"description":"Request to modify the attachments of a student submission.","type":"object","properties":{"addAttachments":{"description":"Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Attachment"}}}},"classroom_v1_ModifyCourseWorkAssigneesRequest":{"description":"Request to modify assignee mode and options of a coursework.","type":"object","properties":{"assigneeMode":{"description":"Mode of the coursework describing whether it will be assigned to all students or specified individual students.","enum":["ASSIGNEE_MODE_UNSPECIFIED","ALL_STUDENTS","INDIVIDUAL_STUDENTS"],"type":"string"},"modifyIndividualStudentsOptions":{"$ref":"#/components/schemas/classroom_v1_ModifyIndividualStudentsOptions"}}},"classroom_v1_ModifyIndividualStudentsOptions":{"description":"Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.","type":"object","properties":{"addStudentIds":{"description":"IDs of students to be added as having access to this coursework/announcement.","type":"array","items":{"type":"string"}},"removeStudentIds":{"description":"IDs of students to be removed from having access to this coursework/announcement.","type":"array","items":{"type":"string"}}}},"classroom_v1_MultipleChoiceQuestion":{"description":"Additional details for multiple-choice questions.","type":"object","properties":{"choices":{"description":"Possible choices.","type":"array","items":{"type":"string"}}}},"classroom_v1_MultipleChoiceSubmission":{"description":"Student work for a multiple-choice question.","type":"object","properties":{"answer":{"description":"Student's select choice.","type":"string"}}},"classroom_v1_Name":{"description":"Details of the user's name.","type":"object","properties":{"familyName":{"description":"The user's last name. Read-only.","type":"string"},"fullName":{"description":"The user's full name formed by concatenating the first and last name values. Read-only.","type":"string"},"givenName":{"description":"The user's first name. Read-only.","type":"string"}}},"classroom_v1_NotebookLmNotebook":{"description":"NotebookLM Notebook link.","type":"object","properties":{"id":{"description":"Notebook resource id.","type":"string"},"title":{"description":"Title of the Notebook.","type":"string"},"url":{"description":"URL that can be used to access the Notebook.","type":"string"}}},"classroom_v1_ReclaimStudentSubmissionRequest":{"description":"Request to reclaim a student submission.","type":"object"},"classroom_v1_Registration":{"description":"An instruction to Classroom to send notifications from the `feed` to the provided destination.","type":"object","properties":{"cloudPubsubTopic":{"$ref":"#/components/schemas/classroom_v1_CloudPubsubTopic"},"expiryTime":{"description":"The time until which the `Registration` is effective. This is a read-only field assigned by the server.","format":"google-datetime","type":"string"},"feed":{"$ref":"#/components/schemas/classroom_v1_Feed"},"registrationId":{"description":"A server-generated unique identifier for this `Registration`. Read-only.","type":"string"}}},"classroom_v1_ReturnStudentSubmissionRequest":{"description":"Request to return a student submission.","type":"object"},"classroom_v1_Rubric":{"description":"The rubric of the course work. A rubric is a scoring guide used to evaluate student work and give feedback. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations).","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"courseWorkId":{"description":"Identifier for the course work this corresponds to. Read-only.","type":"string"},"creationTime":{"description":"Output only. Timestamp when this rubric was created. Read-only.","format":"google-datetime","readOnly":true,"type":"string"},"criteria":{"description":"List of criteria. Each criterion is a dimension on which performance is rated.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_Criterion"}},"id":{"description":"Classroom-assigned identifier for the rubric. This is unique among rubrics for the relevant course work. Read-only.","type":"string"},"sourceSpreadsheetId":{"description":"Input only. Immutable. Google Sheets ID of the spreadsheet. This spreadsheet must contain formatted rubric settings. See [Create or reuse a rubric for an assignment](https://support.google.com/edu/classroom/answer/9335069). Use of this field requires the `https://www.googleapis.com/auth/spreadsheets.readonly` or `https://www.googleapis.com/auth/spreadsheets` scope.","type":"string"},"updateTime":{"description":"Output only. Timestamp of the most recent change to this rubric. Read-only.","format":"google-datetime","readOnly":true,"type":"string"}}},"classroom_v1_RubricGrade":{"description":"A rubric grade set for the student submission. There is at most one entry per rubric criterion.","type":"object","properties":{"criterionId":{"description":"Optional. Criterion ID.","type":"string"},"levelId":{"description":"Optional. Optional level ID of the selected level. If empty, no level was selected.","type":"string"},"points":{"description":"Optional. Optional points assigned for this criterion, typically based on the level. Levels might or might not have points. If unset, no points were set for this criterion.","format":"double","type":"number"}}},"classroom_v1_SharedDriveFile":{"description":"Drive file that is used as material for course work.","type":"object","properties":{"driveFile":{"$ref":"#/components/schemas/classroom_v1_DriveFile"},"shareMode":{"description":"Mechanism by which students access the Drive item.","enum":["UNKNOWN_SHARE_MODE","VIEW","EDIT","STUDENT_COPY"],"type":"string"}}},"classroom_v1_ShortAnswerSubmission":{"description":"Student work for a short answer question.","type":"object","properties":{"answer":{"description":"Student response to a short-answer question.","type":"string"}}},"classroom_v1_StateHistory":{"description":"The history of each state this submission has been in.","type":"object","properties":{"actorUserId":{"description":"The teacher or student who made the change.","type":"string"},"state":{"description":"The workflow pipeline stage.","enum":["STATE_UNSPECIFIED","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT","STUDENT_EDITED_AFTER_TURN_IN"],"type":"string"},"stateTimestamp":{"description":"When the submission entered this state.","format":"google-datetime","type":"string"}}},"classroom_v1_Student":{"description":"Student in a course.","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"profile":{"$ref":"#/components/schemas/classroom_v1_UserProfile"},"studentWorkFolder":{"$ref":"#/components/schemas/classroom_v1_DriveFolder"},"userId":{"description":"Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}}},"classroom_v1_StudentContext":{"description":"Role-specific context if the requesting user is a student.","type":"object","properties":{"submissionId":{"description":"Requesting user's submission id to be used for grade passback and to identify the student when showing student work to the teacher. This is set exactly when `supportsStudentWork` is `true`.","type":"string"}}},"classroom_v1_StudentGroup":{"description":"A student group in a course.","type":"object","properties":{"courseId":{"description":"The identifier of the course.","type":"string"},"id":{"description":"The identifier of the student group.","type":"string"},"title":{"description":"The title of the student group.","type":"string"}}},"classroom_v1_StudentGroupMember":{"description":"A student member in a student group.","type":"object","properties":{"courseId":{"description":"The identifier of the course.","type":"string"},"studentGroupId":{"description":"The identifier of the student group.","type":"string"},"userId":{"description":"Identifier of the student.","type":"string"}}},"classroom_v1_StudentSubmission":{"description":"Student submission for course work. `StudentSubmission` items are generated when a `CourseWork` item is created. Student submissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.","type":"object","properties":{"alternateLink":{"description":"Absolute link to the submission in the Classroom web UI. Read-only.","type":"string"},"assignedGrade":{"description":"Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers.","format":"double","type":"number"},"assignedRubricGrades":{"description":"Assigned rubric grades based on the rubric's Criteria. This map is empty if there is no rubric attached to this course work or if a rubric is attached, but no grades have been set on any Criteria. Entries are only populated for grades that have been set. Key: The rubric's criterion ID. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/classroom_v1_RubricGrade"}},"assignmentSubmission":{"$ref":"#/components/schemas/classroom_v1_AssignmentSubmission"},"associatedWithDeveloper":{"description":"Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.","type":"boolean"},"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"courseWorkId":{"description":"Identifier for the course work this corresponds to. Read-only.","type":"string"},"courseWorkType":{"description":"Type of course work this submission is for. Read-only.","enum":["COURSE_WORK_TYPE_UNSPECIFIED","ASSIGNMENT","SHORT_ANSWER_QUESTION","MULTIPLE_CHOICE_QUESTION"],"type":"string"},"creationTime":{"description":"Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.","format":"google-datetime","type":"string"},"draftGrade":{"description":"Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers.","format":"double","type":"number"},"draftRubricGrades":{"description":"Pending rubric grades based on the rubric's criteria. This map is empty if there is no rubric attached to this course work or if a rubric is attached, but no grades have been set on any criteria. Entries are only populated for grades that have been set. Key: The rubric's criterion ID. Read-only.","type":"object","additionalProperties":{"$ref":"#/components/schemas/classroom_v1_RubricGrade"}},"id":{"description":"Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.","type":"string"},"late":{"description":"Whether this submission is late. Read-only.","type":"boolean"},"multipleChoiceSubmission":{"$ref":"#/components/schemas/classroom_v1_MultipleChoiceSubmission"},"shortAnswerSubmission":{"$ref":"#/components/schemas/classroom_v1_ShortAnswerSubmission"},"state":{"description":"State of this submission. Read-only.","enum":["SUBMISSION_STATE_UNSPECIFIED","NEW","CREATED","TURNED_IN","RETURNED","RECLAIMED_BY_STUDENT"],"type":"string"},"submissionHistory":{"description":"The history of the submission (includes state and grade histories). Read-only.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_SubmissionHistory"}},"updateTime":{"description":"Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.","format":"google-datetime","type":"string"},"userId":{"description":"Identifier for the student that owns this submission. Read-only.","type":"string"}}},"classroom_v1_SubmissionHistory":{"description":"The history of the submission. This currently includes state and grade histories.","type":"object","properties":{"gradeHistory":{"$ref":"#/components/schemas/classroom_v1_GradeHistory"},"stateHistory":{"$ref":"#/components/schemas/classroom_v1_StateHistory"}}},"classroom_v1_Teacher":{"description":"Teacher of a course.","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"profile":{"$ref":"#/components/schemas/classroom_v1_UserProfile"},"userId":{"description":"Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user","type":"string"}}},"classroom_v1_TeacherContext":{"description":"Role-specific context if the requesting user is a teacher.","type":"object"},"classroom_v1_TimeOfDay":{"description":"Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.","type":"object","properties":{"hours":{"description":"Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.","format":"int32","type":"integer"},"minutes":{"description":"Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.","format":"int32","type":"integer"},"nanos":{"description":"Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.","format":"int32","type":"integer"},"seconds":{"description":"Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.","format":"int32","type":"integer"}}},"classroom_v1_Topic":{"description":"Topic created by a teacher for the course","type":"object","properties":{"courseId":{"description":"Identifier of the course. Read-only.","type":"string"},"name":{"description":"The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.","type":"string"},"topicId":{"description":"Unique identifier for the topic. Read-only.","type":"string"},"updateTime":{"description":"The time the topic was last updated by the system. Read-only.","format":"google-datetime","type":"string"}}},"classroom_v1_TurnInStudentSubmissionRequest":{"description":"Request to turn in a student submission.","type":"object"},"classroom_v1_UserProfile":{"description":"Global information for a user.","type":"object","properties":{"emailAddress":{"description":"Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.","type":"string"},"id":{"description":"Identifier of the user. Read-only.","type":"string"},"name":{"$ref":"#/components/schemas/classroom_v1_Name"},"permissions":{"description":"Global permissions of the user. Read-only.","type":"array","items":{"$ref":"#/components/schemas/classroom_v1_GlobalPermission"}},"photoUrl":{"description":"URL of user's profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.","type":"string"},"verifiedTeacher":{"description":"Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only","type":"boolean"}}},"classroom_v1_YouTubeVideo":{"description":"YouTube video item.","type":"object","properties":{"alternateLink":{"description":"URL that can be used to view the YouTube video. Read-only.","type":"string"},"id":{"description":"YouTube API resource ID.","type":"string"},"thumbnailUrl":{"description":"URL of a thumbnail image of the YouTube video. Read-only.","type":"string"},"title":{"description":"Title of the YouTube video. Read-only.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/classroom.announcements":"View and manage announcements in Google Classroom","https://www.googleapis.com/auth/classroom.courses":"See, edit, create, and permanently delete your Google Classroom classes","https://www.googleapis.com/auth/classroom.coursework.me":"See, create and edit coursework items including assignments, questions, and grades","https://www.googleapis.com/auth/classroom.coursework.students":"Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer","https://www.googleapis.com/auth/classroom.courseworkmaterials":"See, edit, and create classwork materials in Google Classroom","https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly":"View your Google Classroom guardians","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly":"View guardians for students in your Google Classroom classes","https://www.googleapis.com/auth/classroom.profile.emails":"View the email addresses of people in your classes","https://www.googleapis.com/auth/classroom.profile.photos":"View the profile photos of people in your classes","https://www.googleapis.com/auth/classroom.rosters":"Manage your Google Classroom class rosters","https://www.googleapis.com/auth/classroom.topics":"See, create, and edit topics in Google Classroom","https://www.googleapis.com/auth/classroom.rosters.readonly":"View your Google Classroom class rosters","https://www.googleapis.com/auth/classroom.courses.readonly":"View your Google Classroom classes","https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly":"See all classwork materials for your Google Classroom classes","https://www.googleapis.com/auth/classroom.topics.readonly":"View topics in Google Classroom","https://www.googleapis.com/auth/classroom.announcements.readonly":"View announcements in Google Classroom","https://www.googleapis.com/auth/classroom.coursework.me.readonly":"View your course work and grades in Google Classroom","https://www.googleapis.com/auth/classroom.coursework.students.readonly":"View course work and grades for students in the Google Classroom classes you teach or administer","https://www.googleapis.com/auth/classroom.student-submissions.me.readonly":"View your course work and grades in Google Classroom","https://www.googleapis.com/auth/classroom.student-submissions.students.readonly":"View course work and grades for students in the Google Classroom classes you teach or administer"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/classroom.announcements","https://www.googleapis.com/auth/classroom.courses","https://www.googleapis.com/auth/classroom.coursework.me","https://www.googleapis.com/auth/classroom.coursework.students","https://www.googleapis.com/auth/classroom.courseworkmaterials","https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly","https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly","https://www.googleapis.com/auth/classroom.profile.emails","https://www.googleapis.com/auth/classroom.profile.photos","https://www.googleapis.com/auth/classroom.rosters","https://www.googleapis.com/auth/classroom.topics"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/classroom/v1/rest","service":"classroom","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-cloud-resource-manager.json b/public/specs/google/google-cloud-resource-manager.json index 06a8ec31..98b31cd0 100644 --- a/public/specs/google/google-cloud-resource-manager.json +++ b/public/specs/google/google-cloud-resource-manager.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Cloud Resource Manager API","version":"v3","description":"Creates, reads, and updates metadata for Google Cloud Platform resource containers."},"servers":[{"url":"https://cloudresourcemanager.googleapis.com/"}],"paths":{"/v3/effectiveTags":{"get":{"operationId":"cloudresourcemanager.effectiveTags.list","x-executor-toolPath":"cloudresourcemanager.effectiveTags.list","tags":["Cloud Resource Manager API"],"description":"Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of effective tags to return in the response. The server allows a maximum of 300 effective tags to return in a single page. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of effective tags to return in the response. The server allows a maximum of 300 effective tags to return in a single page. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListEffectiveTags` that indicates from where this listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListEffectiveTags` that indicates from where this listing should continue.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The full resource name of a resource for which you want to list the effective tags. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","schema":{"description":"Required. The full resource name of a resource for which you want to list the effective tags. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListEffectiveTagsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders":{"get":{"operationId":"cloudresourcemanager.folders.list","x-executor-toolPath":"cloudresourcemanager.folders.list","tags":["Cloud Resource Manager API"],"description":"Lists the folders that are direct descendants of supplied parent resource. `list()` provides a strongly consistent view of the folders underneath the specified parent resource. `list()` returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.","schema":{"description":"Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.","schema":{"description":"Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListFoldersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.folders.create","x-executor-toolPath":"cloudresourcemanager.folders.create","tags":["Cloud Resource Manager API"],"description":"Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track the progress of the folder creation workflow. Upon success, the `Operation.response` field will be populated with the created Folder. In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints. + The folder's `display_name` must be distinct from all other folders that share its parent. + The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the folder must not cause the total number of folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description. Other folder constraint violations will be communicated in the `Operation`, with the specific `PreconditionFailure` returned in the details list in the `Operation.error` field. The caller must have `resourcemanager.folders.create` permission on the identified parent.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}":{"get":{"operationId":"cloudresourcemanager.folders.get","x-executor-toolPath":"cloudresourcemanager.folders.get","tags":["Cloud Resource Manager API"],"description":"Retrieves a folder identified by the supplied resource name. Valid folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to retrieve. Must be of the form `folders/{folder_id}`.","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to retrieve. Must be of the form `folders/{folder_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.folders.delete","x-executor-toolPath":"cloudresourcemanager.folders.delete","tags":["Cloud Resource Manager API"],"description":"Requests deletion of a folder. The folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the ACTIVE state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-op success. The caller must have `resourcemanager.folders.delete` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to be deleted. Must be of the form `folders/{folder_id}`.","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to be deleted. Must be of the form `folders/{folder_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.folders.patch","x-executor-toolPath":"cloudresourcemanager.folders.patch","tags":["Cloud Resource Manager API"],"description":"Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be rejected if they violate either the `display_name` formatting rules or the naming constraints described in the CreateFolder documentation. The folder's `display_name` must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\\p{L}\\p{N}{1,28}[\\p{L}\\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a `PreconditionFailure` explaining this violation will be returned in the Status.details field.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Fields to be updated. Only the `display_name` can be updated.","schema":{"description":"Required. Fields to be updated. Only the `display_name` can be updated.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}/capabilities/{capabilitiesId}":{"get":{"operationId":"cloudresourcemanager.folders.capabilities.get","x-executor-toolPath":"cloudresourcemanager.folders.capabilities.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the Capability identified by the supplied resource name.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","type":"string"},"allowReserved":true},{"name":"capabilitiesId","in":"path","required":true,"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","schema":{"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Capability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.folders.capabilities.patch","x-executor-toolPath":"cloudresourcemanager.folders.capabilities.patch","tags":["Cloud Resource Manager API"],"description":"Updates the Capability.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","type":"string"},"allowReserved":true},{"name":"capabilitiesId","in":"path","required":true,"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","schema":{"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update. Only [Capability.value] can be updated.","schema":{"description":"Optional. The list of fields to update. Only [Capability.value] can be updated.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Capability"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}/capabilityConfigs":{"get":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.list","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.list","tags":["Cloud Resource Manager API"],"description":"Lists CapabilityConfigs that are direct children of the specified organization, folder or project resource.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","schema":{"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","schema":{"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListCapabilityConfigsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.create","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.create","tags":["Cloud Resource Manager API"],"description":"Creates a CapabilityConfig under a parent Organization, Folder or Project. Creating a CapabilityConfig triggers the creation of a Management Project if one is not supplied.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","schema":{"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"capabilityConfigId","in":"query","required":false,"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","schema":{"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}":{"get":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.get","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.delete","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.delete","tags":["Cloud Resource Manager API"],"description":"Deletes the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.patch","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name`, `types` and `boundaries` of the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update.","schema":{"description":"Optional. The list of fields to update.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.folders.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.folders.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the folder's resource name, for example: \"folders/1234\". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:move":{"post":{"operationId":"cloudresourcemanager.folders.move","x-executor-toolPath":"cloudresourcemanager.folders.move","tags":["Cloud Resource Manager API"],"description":"Moves a folder under a new resource parent. Returns an `Operation` which can be used to track the progress of the folder move workflow. Upon success, the `Operation.response` field will be populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the failure cause will be returned - if the failure occurs synchronously then the `FolderOperationError` will be returned in the `Status.details` field. If it occurs asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_MoveFolderRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.folders.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.folders.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on a folder, replacing any existing policy. The `resource` field should be the folder's resource name, for example: \"folders/1234\". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.folders.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.folders.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified folder. The `resource` field should be the folder's resource name, for example: \"folders/1234\". There are no permissions required for making this API call.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:undelete":{"post":{"operationId":"cloudresourcemanager.folders.undelete","x-executor-toolPath":"cloudresourcemanager.folders.undelete","tags":["Cloud Resource Manager API"],"description":"Cancels the deletion request for a folder. This method may be called on a folder in any state. If the folder is in the ACTIVE state the result will be a no-op success. In order to succeed, the folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to undelete. Must be of the form `folders/{folder_id}`.","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to undelete. Must be of the form `folders/{folder_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_UndeleteFolderRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders:search":{"get":{"operationId":"cloudresourcemanager.folders.search","x-executor-toolPath":"cloudresourcemanager.folders.search","tags":["Cloud Resource Manager API"],"description":"Search for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The `displayName` field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. ``` | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | ``` Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\". * Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".","schema":{"description":"Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The `displayName` field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. ``` | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | ``` Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\". * Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SearchFoldersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/liens":{"get":{"operationId":"cloudresourcemanager.liens.list","x-executor-toolPath":"cloudresourcemanager.liens.list","tags":["Cloud Resource Manager API"],"description":"List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default.","schema":{"description":"The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The `next_page_token` value returned from a previous List request, if any.","schema":{"description":"The `next_page_token` value returned from a previous List request, if any.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The name of the resource to list all attached Liens. For example, `projects/1234`. (google.api.field_policy).resource_type annotation is not set since the parent depends on the meta api implementation. This field could be a project or other sub project resources.","schema":{"description":"Required. The name of the resource to list all attached Liens. For example, `projects/1234`. (google.api.field_policy).resource_type annotation is not set since the parent depends on the meta api implementation. This field could be a project or other sub project resources.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListLiensResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.liens.create","x-executor-toolPath":"cloudresourcemanager.liens.create","tags":["Cloud Resource Manager API"],"description":"Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/liens/{liensId}":{"get":{"operationId":"cloudresourcemanager.liens.get","x-executor-toolPath":"cloudresourcemanager.liens.get","tags":["Cloud Resource Manager API"],"description":"Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`","parameters":[{"name":"liensId","in":"path","required":true,"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien.","schema":{"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.liens.delete","x-executor-toolPath":"cloudresourcemanager.liens.delete","tags":["Cloud Resource Manager API"],"description":"Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`.","parameters":[{"name":"liensId","in":"path","required":true,"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien to delete.","schema":{"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}":{"get":{"operationId":"cloudresourcemanager.locations.effectiveTagBindingCollections.get","x-executor-toolPath":"cloudresourcemanager.locations.effectiveTagBindingCollections.get","tags":["Cloud Resource Manager API"],"description":"Returns effective tag bindings on a GCP resource.","parameters":[{"name":"locationsId","in":"path","required":true,"description":"`locationsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`locationsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"effectiveTagBindingCollectionsId","in":"path","required":true,"description":"`effectiveTagBindingCollectionsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`effectiveTagBindingCollectionsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_EffectiveTagBindingCollection"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}":{"get":{"operationId":"cloudresourcemanager.locations.tagBindingCollections.get","x-executor-toolPath":"cloudresourcemanager.locations.tagBindingCollections.get","tags":["Cloud Resource Manager API"],"description":"Returns tag bindings directly attached to a GCP resource.","parameters":[{"name":"locationsId","in":"path","required":true,"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"tagBindingCollectionsId","in":"path","required":true,"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBindingCollection"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.locations.tagBindingCollections.patch","x-executor-toolPath":"cloudresourcemanager.locations.tagBindingCollections.patch","tags":["Cloud Resource Manager API"],"description":"Updates tag bindings directly attached to a GCP resource. Update_mask can be kept empty or \"*\".","parameters":[{"name":"locationsId","in":"path","required":true,"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"tagBindingCollectionsId","in":"path","required":true,"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. An update mask to selectively update fields.","schema":{"description":"Optional. An update mask to selectively update fields.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBindingCollection"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/operations/{operationsId}":{"get":{"operationId":"cloudresourcemanager.operations.get","x-executor-toolPath":"cloudresourcemanager.operations.get","tags":["Cloud Resource Manager API"],"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","parameters":[{"name":"operationsId","in":"path","required":true,"description":"`operationsId` of `name` (`operations/{operationsId}`). The name of the operation resource.","schema":{"description":"`operationsId` of `name` (`operations/{operationsId}`). The name of the operation resource.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}":{"get":{"operationId":"cloudresourcemanager.organizations.get","x-executor-toolPath":"cloudresourcemanager.organizations.get","tags":["Cloud Resource Manager API"],"description":"Fetches an organization resource identified by the specified resource name.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}`). Required. The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as \"organizations/[organizationId]\". For example, \"organizations/1234\".","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}`). Required. The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as \"organizations/[organizationId]\". For example, \"organizations/1234\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Organization"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}/capabilityConfigs":{"get":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.list","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.list","tags":["Cloud Resource Manager API"],"description":"Lists CapabilityConfigs that are direct children of the specified organization, folder or project resource.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","schema":{"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","schema":{"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListCapabilityConfigsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.create","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.create","tags":["Cloud Resource Manager API"],"description":"Creates a CapabilityConfig under a parent Organization, Folder or Project. Creating a CapabilityConfig triggers the creation of a Management Project if one is not supplied.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","schema":{"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"capabilityConfigId","in":"query","required":false,"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","schema":{"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}":{"get":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.get","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.delete","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.delete","tags":["Cloud Resource Manager API"],"description":"Deletes the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.patch","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name`, `types` and `boundaries` of the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update.","schema":{"description":"Optional. The list of fields to update.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.organizations.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.organizations.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for an organization resource. The policy may be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, for example: \"organizations/123\". Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified organization.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.organizations.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.organizations.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: \"organizations/123\". Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified organization.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.organizations.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.organizations.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns the permissions that a caller has on the specified organization. The `resource` field should be the organization's resource name, for example: \"organizations/123\". There are no permissions required for making this API call.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations:search":{"get":{"operationId":"cloudresourcemanager.organizations.search","x-executor-toolPath":"cloudresourcemanager.organizations.search","tags":["Cloud Resource Manager API"],"description":"Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear. Search will only return organizations on which the user has the permission `resourcemanager.organizations.get` or has super admin privileges.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.","schema":{"description":"Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SearchOrganizationsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects":{"get":{"operationId":"cloudresourcemanager.projects.list","x-executor-toolPath":"cloudresourcemanager.projects.list","tags":["Cloud Resource Manager API"],"description":"Lists projects that are direct children of the specified folder or organization resource. `list()` provides a strongly consistent view of the projects underneath the specified parent resource. `list()` returns projects sorted based upon the (ascending) lexical ordering of their `display_name`. The caller must have `resourcemanager.projects.list` permission on the identified parent.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`.","schema":{"description":"Required. The name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be returned. Normally only `ACTIVE` projects are returned.","schema":{"description":"Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be returned. Normally only `ACTIVE` projects are returned.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListProjectsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.projects.create","x-executor-toolPath":"cloudresourcemanager.projects.create","tags":["Cloud Resource Manager API"],"description":"Request that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}":{"get":{"operationId":"cloudresourcemanager.projects.get","x-executor-toolPath":"cloudresourcemanager.projects.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the project identified by the specified `name` (for example, `projects/415104041262`). The caller must have `resourcemanager.projects.get` permission for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`).","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.projects.delete","x-executor-toolPath":"cloudresourcemanager.projects.delete","tags":["Cloud Resource Manager API"],"description":"Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. The caller must have `resourcemanager.projects.delete` permissions for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the Project (for example, `projects/415104041262`).","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the Project (for example, `projects/415104041262`).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.projects.patch","x-executor-toolPath":"cloudresourcemanager.projects.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name` and labels of the project identified by the specified `name` (for example, `projects/415104041262`). Deleting all labels requires an update mask for labels field. The caller must have `resourcemanager.projects.update` permission for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Output only. The unique resource name of the project. It is an int64 generated number prefixed by \"projects/\". Example: `projects/415104041262`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Output only. The unique resource name of the project. It is an int64 generated number prefixed by \"projects/\". Example: `projects/415104041262`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. An update mask to selectively update fields.","schema":{"description":"Optional. An update mask to selectively update fields.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}/capabilityConfigs":{"get":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.list","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.list","tags":["Cloud Resource Manager API"],"description":"Lists CapabilityConfigs that are direct children of the specified organization, folder or project resource.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","schema":{"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","schema":{"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListCapabilityConfigsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.create","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.create","tags":["Cloud Resource Manager API"],"description":"Creates a CapabilityConfig under a parent Organization, Folder or Project. Creating a CapabilityConfig triggers the creation of a Management Project if one is not supplied.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","schema":{"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"capabilityConfigId","in":"query","required":false,"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","schema":{"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}":{"get":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.get","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.delete","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.delete","tags":["Cloud Resource Manager API"],"description":"Deletes the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.patch","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name`, `types` and `boundaries` of the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update.","schema":{"description":"Optional. The list of fields to update.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.projects.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.projects.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:move":{"post":{"operationId":"cloudresourcemanager.projects.move","x-executor-toolPath":"cloudresourcemanager.projects.move","tags":["Cloud Resource Manager API"],"description":"Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project to move.","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project to move.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_MoveProjectRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.projects.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.projects.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.projects.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.projects.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123..","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:undelete":{"post":{"operationId":"cloudresourcemanager.projects.undelete","x-executor-toolPath":"cloudresourcemanager.projects.undelete","tags":["Cloud Resource Manager API"],"description":"Restores the project identified by the specified `name` (for example, `projects/415104041262`). You can only use this method for a project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the project cannot be restored. The caller must have `resourcemanager.projects.undelete` permission for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`). Required.","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`). Required.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_UndeleteProjectRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects:search":{"get":{"operationId":"cloudresourcemanager.projects.search","x-executor-toolPath":"cloudresourcemanager.projects.search","tags":["Cloud Resource Manager API"],"description":"Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.","schema":{"description":"Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SearchProjectsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagBindings":{"get":{"operationId":"cloudresourcemanager.tagBindings.list","x-executor-toolPath":"cloudresourcemanager.tagBindings.list","tags":["Cloud Resource Manager API"],"description":"Lists the TagBindings for the given Google Cloud resource, as specified with `parent`. NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","schema":{"description":"Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagBindingsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagBindings.create","x-executor-toolPath":"cloudresourcemanager.tagBindings.create","tags":["Cloud Resource Manager API"],"description":"Creates a TagBinding between a TagValue and a Google Cloud resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBinding"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagBindings/{tagBindingsId}":{"delete":{"operationId":"cloudresourcemanager.tagBindings.delete","x-executor-toolPath":"cloudresourcemanager.tagBindings.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagBinding.","parameters":[{"name":"tagBindingsId","in":"path","required":true,"description":"`tagBindingsId` of `name` (`tagBindings/{tagBindingsId}`). Required. The name of the TagBinding. This is a String of the form: `tagBindings/{id}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).","schema":{"description":"`tagBindingsId` of `name` (`tagBindings/{tagBindingsId}`). Required. The name of the TagBinding. This is a String of the form: `tagBindings/{id}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys":{"get":{"operationId":"cloudresourcemanager.tagKeys.list","x-executor-toolPath":"cloudresourcemanager.tagKeys.list","tags":["Cloud Resource Manager API"],"description":"Lists all TagKeys for a parent resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagKeys to return in the response. The server allows a maximum of 300 TagKeys to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagKeys to return in the response. The server allows a maximum of 300 TagKeys to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagKey` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagKey` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The resource name of the TagKey's parent. Must be of the form `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`","schema":{"description":"Required. The resource name of the TagKey's parent. Must be of the form `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagKeysResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagKeys.create","x-executor-toolPath":"cloudresourcemanager.tagKeys.create","tags":["Cloud Resource Manager API"],"description":"Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/namespaced":{"get":{"operationId":"cloudresourcemanager.tagKeys.getNamespaced","x-executor-toolPath":"cloudresourcemanager.tagKeys.getNamespaced","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"name","in":"query","required":false,"description":"Required. A namespaced tag key name in the format `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name \"foo\" under the organization with ID 42 or `r2-d2/bar` for a key with short name \"bar\" under the project `r2-d2`.","schema":{"description":"Required. A namespaced tag key name in the format `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name \"foo\" under the organization with ID 42 or `r2-d2/bar` for a key with short name \"bar\" under the project `r2-d2`.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}":{"get":{"operationId":"cloudresourcemanager.tagKeys.get","x-executor-toolPath":"cloudresourcemanager.tagKeys.get","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.","schema":{"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.tagKeys.delete","x-executor-toolPath":"cloudresourcemanager.tagKeys.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.","schema":{"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"etag","in":"query","required":false,"description":"Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.","schema":{"description":"Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.","schema":{"description":"Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.tagKeys.patch","x-executor-toolPath":"cloudresourcemanager.tagKeys.patch","tags":["Cloud Resource Manager API"],"description":"Updates the attributes of the TagKey resource.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey.","schema":{"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Fields to be updated. The mask may only contain `description` or `etag`. If omitted entirely, both `description` and `etag` are assumed to be significant.","schema":{"description":"Fields to be updated. The mask may only contain `description` or `etag`. If omitted entirely, both `description` and `etag` are assumed to be significant.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Set as true to perform validations necessary for updating the resource, but not actually perform the action.","schema":{"description":"Set as true to perform validations necessary for updating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagKeys.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagKeys.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, \"tagKeys/1234\". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagKeys.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagKeys.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, \"tagKeys/1234\". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.tagKeys.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.tagKeys.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, \"tagKeys/1234\". There are no permissions required for making this API call.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues":{"get":{"operationId":"cloudresourcemanager.tagValues.list","x-executor-toolPath":"cloudresourcemanager.tagValues.list","tags":["Cloud Resource Manager API"],"description":"Lists all TagValues for a specific TagKey.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagValues to return in the response. The server allows a maximum of 300 TagValues to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagValues to return in the response. The server allows a maximum of 300 TagValues to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagValues` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagValues` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. Resource name for the parent of the TagValues to be listed, in the format `tagKeys/123` or `tagValues/123`.","schema":{"description":"Required. Resource name for the parent of the TagValues to be listed, in the format `tagKeys/123` or `tagValues/123`.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagValues.create","x-executor-toolPath":"cloudresourcemanager.tagValues.create","tags":["Cloud Resource Manager API"],"description":"Creates a TagValue as a child of the specified TagKey. If a another request with the same parameters is sent while the original request is in process the second request will receive an error. A maximum of 1000 TagValues can exist under a TagKey at any given time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set as true to perform the validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set as true to perform the validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/namespaced":{"get":{"operationId":"cloudresourcemanager.tagValues.getNamespaced","x-executor-toolPath":"cloudresourcemanager.tagValues.getNamespaced","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagValue by its namespaced name. This method will return `PERMISSION_DENIED` if the value does not exist or the user does not have permission to view it.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"name","in":"query","required":false,"description":"Required. A namespaced tag value name in the following format: `{parentId}/{tagKeyShort}/{tagValueShort}` Examples: - `42/foo/abc` for a value with short name \"abc\" under the key with short name \"foo\" under the organization with ID 42 - `r2-d2/bar/xyz` for a value with short name \"xyz\" under the key with short name \"bar\" under the project with ID \"r2-d2\"","schema":{"description":"Required. A namespaced tag value name in the following format: `{parentId}/{tagKeyShort}/{tagValueShort}` Examples: - `42/foo/abc` for a value with short name \"abc\" under the key with short name \"foo\" under the organization with ID 42 - `r2-d2/bar/xyz` for a value with short name \"xyz\" under the key with short name \"bar\" under the project with ID \"r2-d2\"","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}":{"get":{"operationId":"cloudresourcemanager.tagValues.get","x-executor-toolPath":"cloudresourcemanager.tagValues.get","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagValue. This method will return `PERMISSION_DENIED` if the value does not exist or the user does not have permission to view it.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be fetched in the format `tagValues/456`.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be fetched in the format `tagValues/456`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.tagValues.delete","x-executor-toolPath":"cloudresourcemanager.tagValues.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be deleted in the format tagValues/456.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be deleted in the format tagValues/456.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"etag","in":"query","required":false,"description":"Optional. The etag known to the client for the expected state of the TagValue. This is to be used for optimistic concurrency.","schema":{"description":"Optional. The etag known to the client for the expected state of the TagValue. This is to be used for optimistic concurrency.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set as true to perform the validations necessary for deletion, but not actually perform the action.","schema":{"description":"Optional. Set as true to perform the validations necessary for deletion, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.tagValues.patch","x-executor-toolPath":"cloudresourcemanager.tagValues.patch","tags":["Cloud Resource Manager API"],"description":"Updates the attributes of the TagValue resource.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Immutable. Resource name for TagValue in the format `tagValues/456`.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Immutable. Resource name for TagValue in the format `tagValues/456`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Fields to be updated.","schema":{"description":"Optional. Fields to be updated.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. True to perform validations necessary for updating the resource, but not actually perform the action.","schema":{"description":"Optional. True to perform validations necessary for updating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}/tagHolds/{tagHoldsId}":{"delete":{"operationId":"cloudresourcemanager.tagValues.tagHolds.delete","x-executor-toolPath":"cloudresourcemanager.tagValues.tagHolds.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagHold.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","type":"string"},"allowReserved":true},{"name":"tagHoldsId","in":"path","required":true,"description":"`tagHoldsId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","schema":{"description":"`tagHoldsId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform the validations necessary for deleting the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform the validations necessary for deleting the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagValues.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagValues.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. The caller must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` permission on the identified TagValue to get the access control policy.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagValues.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagValues.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on a TagValue, replacing any existing policy. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` permission on the identified tagValue.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.tagValues.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.tagValues.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified TagValue. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. There are no permissions required for making this API call.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/{parent}/tagHolds":{"get":{"operationId":"cloudresourcemanager.tagValues.tagHolds.list","x-executor-toolPath":"cloudresourcemanager.tagValues.tagHolds.list","tags":["Cloud Resource Manager API"],"description":"Lists TagHolds under a TagValue.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","schema":{"description":"Required. The resource name of the parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the `holder` and `origin` fields are supported for filtering. Currently only `AND` syntax is supported. Some example queries are: * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` * `origin = 35678234` * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234`","schema":{"description":"Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the `holder` and `origin` fields are supported for filtering. Currently only `AND` syntax is supported. Some example queries are: * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` * `origin = 35678234` * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234`","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagHolds` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagHolds` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagHoldsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagValues.tagHolds.create","x-executor-toolPath":"cloudresourcemanager.tagValues.tagHolds.create","tags":["Cloud Resource Manager API"],"description":"Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same resource and origin exists under the same TagValue.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the TagHold's parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","schema":{"description":"Required. The resource name of the TagHold's parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagHold"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3:fetchResourceSemantics":{"get":{"operationId":"cloudresourcemanager.fetchResourceSemantics","x-executor-toolPath":"cloudresourcemanager.fetchResourceSemantics","tags":["Cloud Resource Manager API"],"description":"Returns the semantics associated with the specified resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"fullResourceName","in":"query","required":false,"description":"Required. The full resource name of the GCP resource to retrieve semantics for. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"","schema":{"description":"Required. The full resource name of the GCP resource to retrieve semantics for. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_FetchResourceSemanticsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}}},"components":{"schemas":{"cloudresourcemanager_v3_AuditConfig":{"description":"Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.","type":"object","properties":{"auditLogConfigs":{"description":"The configuration for logging of each type of permission.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_AuditLogConfig"}},"service":{"description":"Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.","type":"string"}}},"cloudresourcemanager_v3_AuditLogConfig":{"description":"Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.","type":"object","properties":{"exemptedMembers":{"description":"Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.","type":"array","items":{"type":"string"}},"logType":{"description":"The log type that this config enables.","enum":["LOG_TYPE_UNSPECIFIED","ADMIN_READ","DATA_WRITE","DATA_READ"],"type":"string"}}},"cloudresourcemanager_v3_Binding":{"description":"Associates `members`, or principals, with a `role`.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Expr"},"members":{"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.","type":"array","items":{"type":"string"}},"role":{"description":"Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).","type":"string"}}},"cloudresourcemanager_v3_Capability":{"description":"Representation of a Capability.","type":"object","properties":{"name":{"description":"Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","type":"string"},"value":{"description":"Required. The configured value of the capability at the given parent resource.","type":"boolean"}}},"cloudresourcemanager_v3_CapabilityConfig":{"description":"A CapabilityConfig allows managing experiences like applications and agents on a logical administrative perimeter of Projects (Boundary).","type":"object","properties":{"boundaries":{"description":"Optional. The list of Boundaries associated with this CapabilityConfig. Format: `organizations/{organization}/boundaries/{boundary}` or, `folders/{folder}/boundaries/{boundary}` or, `projects/{project}/boundaries/{boundary}`","type":"array","items":{"type":"string"}},"createTime":{"description":"Output only. The creation time of the CapabilityConfig.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"Optional. Human-readable non-unique display name of the CapabilityConfig. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My CapabilityConfig`","type":"string"},"etag":{"description":"This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","type":"string"},"managementProject":{"description":"Optional. Immutable. The Management Project associated with this CapabilityConfig. If not provided during creation, a management project will be automatically created. Cannot be modified after creation. Format: `projects/{project_number}` Example: `projects/123456789012`","type":"string"},"name":{"description":"Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"state":{"description":"Output only. The lifecycle state of the CapabilityConfig.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE"],"type":"string"},"types":{"description":"Required. The CapabilityConfig types.","type":"array","items":{"enum":["TYPE_UNSPECIFIED","APP_MANAGEMENT","AGENT_MANAGEMENT"],"type":"string"}},"updateTime":{"description":"Output only. The most recent time this CapabilityConfig was modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation":{"description":"Metadata describing a long running folder operation","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization we are either creating the folder under or moving the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"operationType":{"description":"The type of this operation.","enum":["OPERATION_TYPE_UNSPECIFIED","CREATE","MOVE"],"type":"string"},"sourceParent":{"description":"The resource name of the folder's parent. Only applicable when the operation_type is MOVE.","type":"string"}}},"cloudresourcemanager_v3_CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation":{"description":"Metadata describing a long running folder operation","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization we are either creating the folder under or moving the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"operationType":{"description":"The type of this operation.","enum":["OPERATION_TYPE_UNSPECIFIED","CREATE","MOVE"],"type":"string"},"sourceParent":{"description":"The resource name of the folder's parent. Only applicable when the operation_type is MOVE.","type":"string"}}},"cloudresourcemanager_v3_CreateBoundaryMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateBoundary. Currently empty.","type":"object"},"cloudresourcemanager_v3_CreateCapabilityConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateCapabilityConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_CreateFolderMetadata":{"description":"Metadata pertaining to the Folder creation process.","type":"object","properties":{"displayName":{"description":"The display name of the folder.","type":"string"},"parent":{"description":"The resource name of the folder or organization we are creating the folder under.","type":"string"}}},"cloudresourcemanager_v3_CreateProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.","type":"object","properties":{"createTime":{"description":"Creation time of the project creation workflow.","format":"google-datetime","type":"string"},"gettable":{"description":"True if the project can be retrieved using `GetProject`. No other operations on the project are guaranteed to work until the project creation is complete.","type":"boolean"},"ready":{"description":"True if the project creation process is complete.","type":"boolean"}}},"cloudresourcemanager_v3_CreateTagBindingMetadata":{"description":"Runtime operation information for creating a TagValue.","type":"object"},"cloudresourcemanager_v3_CreateTagKeyMetadata":{"description":"Runtime operation information for creating a TagKey.","type":"object"},"cloudresourcemanager_v3_CreateTagValueMetadata":{"description":"Runtime operation information for creating a TagValue.","type":"object"},"cloudresourcemanager_v3_DeleteBoundaryMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by DeleteBoundary. Currently empty.","type":"object"},"cloudresourcemanager_v3_DeleteCapabilityConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by DeleteCapabilityConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_DeleteFolderMetadata":{"description":"A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.","type":"object"},"cloudresourcemanager_v3_DeleteOrganizationMetadata":{"description":"A status object which is used as the `metadata` field for the operation returned by DeleteOrganization.","type":"object"},"cloudresourcemanager_v3_DeleteProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by `DeleteProject`.","type":"object"},"cloudresourcemanager_v3_DeleteTagBindingMetadata":{"description":"Runtime operation information for deleting a TagBinding.","type":"object"},"cloudresourcemanager_v3_DeleteTagKeyMetadata":{"description":"Runtime operation information for deleting a TagKey.","type":"object"},"cloudresourcemanager_v3_DeleteTagValueMetadata":{"description":"Runtime operation information for deleting a TagValue.","type":"object"},"cloudresourcemanager_v3_EffectiveTag":{"description":"An EffectiveTag represents a tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. EffectiveTag contains the name and namespaced_name of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.","type":"object","properties":{"inherited":{"description":"Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.","type":"boolean"},"namespacedTagKey":{"description":"The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.","type":"string"},"namespacedTagValue":{"description":"The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.","type":"string"},"tagKey":{"description":"The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.","type":"string"},"tagKeyParentName":{"description":"The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`","type":"string"},"tagValue":{"description":"Resource name for TagValue in the format `tagValues/456`.","type":"string"}}},"cloudresourcemanager_v3_EffectiveTagBindingCollection":{"description":"Represents a collection of effective tag bindings for a GCP resource.","type":"object","properties":{"effectiveTags":{"description":"Tag keys/values effectively bound to this resource, specified in namespaced format. For example: \"123/environment\": \"production\"","type":"object","additionalProperties":{"type":"string"}},"fullResourceName":{"description":"The full resource name of the resource the TagBindings are bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`","type":"string"},"name":{"description":"Identifier. The name of the EffectiveTagBindingCollection, following the convention: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"}}},"cloudresourcemanager_v3_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"cloudresourcemanager_v3_Expr":{"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.","type":"object","properties":{"description":{"description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.","type":"string"},"expression":{"description":"Textual representation of an expression in Common Expression Language syntax.","type":"string"},"location":{"description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.","type":"string"},"title":{"description":"Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.","type":"string"}}},"cloudresourcemanager_v3_FetchResourceSemanticsResponse":{"description":"Response message for FetchResourceSemantics.","type":"object","properties":{"fullResourceName":{"description":"The full resource name for which semantics are returned. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"","type":"string"},"semantics":{"description":"Map of resource semantics (e.g., `\"ENVIRONMENT\": \"PRODUCTION\"`).","type":"object","additionalProperties":{"type":"string"}}}},"cloudresourcemanager_v3_Folder":{"description":"A folder in an organization's resource hierarchy, used to organize that organization's resources.","type":"object","properties":{"configuredCapabilities":{"description":"Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`.","readOnly":true,"type":"array","items":{"type":"string"}},"createTime":{"description":"Output only. Timestamp when the folder was created.","format":"google-datetime","readOnly":true,"type":"string"},"deleteTime":{"description":"Output only. Timestamp when the folder was requested to be deleted.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\\p{L}\\p{N}]([\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?`.","type":"string"},"etag":{"description":"Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","readOnly":true,"type":"string"},"managementProject":{"description":"Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY.","readOnly":true,"type":"string"},"name":{"description":"Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".","type":"string"},"parent":{"description":"Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.","type":"string"},"state":{"description":"Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","DELETE_REQUESTED"],"type":"string"},"tags":{"description":"Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.","type":"object","additionalProperties":{"type":"string"}},"updateTime":{"description":"Output only. Timestamp when the folder was last modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_FolderOperation":{"description":"Metadata describing a long running folder operation","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization we are either creating the folder under or moving the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"operationType":{"description":"The type of this operation.","enum":["OPERATION_TYPE_UNSPECIFIED","CREATE","MOVE"],"type":"string"},"sourceParent":{"description":"The resource name of the folder's parent. Only applicable when the operation_type is MOVE.","type":"string"}}},"cloudresourcemanager_v3_FolderOperationError":{"description":"A classification of the Folder Operation error.","type":"object","properties":{"errorMessageId":{"description":"The type of operation error experienced.","enum":["ERROR_TYPE_UNSPECIFIED","ACTIVE_FOLDER_HEIGHT_VIOLATION","MAX_CHILD_FOLDERS_VIOLATION","FOLDER_NAME_UNIQUENESS_VIOLATION","RESOURCE_DELETED_VIOLATION","PARENT_DELETED_VIOLATION","CYCLE_INTRODUCED_VIOLATION","FOLDER_BEING_MOVED_VIOLATION","FOLDER_TO_DELETE_NON_EMPTY_VIOLATION","DELETED_FOLDER_HEIGHT_VIOLATION","FOLDER_TO_DELETE_CONFIGURED_CAPABILITY_VIOLATION"],"type":"string"}}},"cloudresourcemanager_v3_GetIamPolicyRequest":{"description":"Request message for `GetIamPolicy` method.","type":"object","properties":{"options":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetPolicyOptions"}}},"cloudresourcemanager_v3_GetPolicyOptions":{"description":"Encapsulates settings provided to GetIamPolicy.","type":"object","properties":{"requestedPolicyVersion":{"description":"Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"cloudresourcemanager_v3_Lien":{"description":"A Lien represents an encumbrance on the actions that can be performed on a resource.","type":"object","properties":{"createTime":{"description":"The creation time of this Lien.","format":"google-datetime","type":"string"},"name":{"description":"A system-generated unique identifier for this Lien. Example: `liens/1234abcd`","type":"string"},"origin":{"description":"A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com'","type":"string"},"parent":{"description":"A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234`","type":"string"},"reason":{"description":"Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key'","type":"string"},"restrictions":{"description":"The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete']","type":"array","items":{"type":"string"}}}},"cloudresourcemanager_v3_ListCapabilityConfigsResponse":{"description":"A page of the response received from the ListCapabilityConfigs method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next page. NOTE: A response may contain fewer elements than the request `page_size` and still have a `next_page_token`.","type":"object","properties":{"capabilityConfigs":{"description":"The list of CapabilityConfigs under the parent. This list can be paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}},"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.","type":"string"}}},"cloudresourcemanager_v3_ListEffectiveTagsResponse":{"description":"The response of ListEffectiveTags.","type":"object","properties":{"effectiveTags":{"description":"A possibly paginated list of effective tags for the specified resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_EffectiveTag"}},"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"}}},"cloudresourcemanager_v3_ListFoldersResponse":{"description":"The ListFolders response message.","type":"object","properties":{"folders":{"description":"A possibly paginated list of folders that are direct descendants of the specified parent resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}},"nextPageToken":{"description":"A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue.","type":"string"}}},"cloudresourcemanager_v3_ListLiensResponse":{"description":"The response message for Liens.ListLiens.","type":"object","properties":{"liens":{"description":"A list of Liens.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}},"nextPageToken":{"description":"Token to retrieve the next page of results, or empty if there are no more results in the list.","type":"string"}}},"cloudresourcemanager_v3_ListProjectsResponse":{"description":"A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page. NOTE: A response may contain fewer elements than the request `page_size` and still have a `next_page_token`.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"projects":{"description":"The list of Projects under the parent. This list can be paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"cloudresourcemanager_v3_ListTagBindingsResponse":{"description":"The ListTagBindings response.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"tagBindings":{"description":"A possibly paginated list of TagBindings for the specified resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBinding"}}}},"cloudresourcemanager_v3_ListTagHoldsResponse":{"description":"The ListTagHolds response.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"tagHolds":{"description":"A possibly paginated list of TagHolds.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagHold"}}}},"cloudresourcemanager_v3_ListTagKeysResponse":{"description":"The ListTagKeys response message.","type":"object","properties":{"nextPageToken":{"description":"A pagination token returned from a previous call to `ListTagKeys` that indicates from where listing should continue.","type":"string"},"tagKeys":{"description":"List of TagKeys that live under the specified parent in the request.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}},"cloudresourcemanager_v3_ListTagValuesResponse":{"description":"The ListTagValues response.","type":"object","properties":{"nextPageToken":{"description":"A pagination token returned from a previous call to `ListTagValues` that indicates from where listing should continue.","type":"string"},"tagValues":{"description":"A possibly paginated list of TagValues that are direct descendants of the specified parent TagKey.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}},"cloudresourcemanager_v3_MoveFolderMetadata":{"description":"Metadata pertaining to the folder move process.","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization to move the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"sourceParent":{"description":"The resource name of the folder's parent.","type":"string"}}},"cloudresourcemanager_v3_MoveFolderRequest":{"description":"The MoveFolder request message.","type":"object","properties":{"destinationParent":{"description":"Required. The resource name of the folder or organization which should be the folder's new parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.","type":"string"}}},"cloudresourcemanager_v3_MoveProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by MoveProject.","type":"object"},"cloudresourcemanager_v3_MoveProjectRequest":{"description":"The request sent to MoveProject method.","type":"object","properties":{"destinationParent":{"description":"Required. The new parent to move the Project under.","type":"string"}}},"cloudresourcemanager_v3_Operation":{"description":"This resource represents a long-running operation that is the result of a network API call.","type":"object","properties":{"done":{"description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.","type":"boolean"},"error":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Status"},"metadata":{"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}},"name":{"description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.","type":"string"},"response":{"description":"The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}}},"cloudresourcemanager_v3_Organization":{"description":"The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.","type":"object","properties":{"createTime":{"description":"Output only. Timestamp when the Organization was created.","format":"google-datetime","readOnly":true,"type":"string"},"deleteTime":{"description":"Output only. Timestamp when the Organization was requested for deletion.","format":"google-datetime","readOnly":true,"type":"string"},"directoryCustomerId":{"description":"Immutable. The G Suite / Workspace customer id used in the Directory API.","type":"string"},"displayName":{"description":"Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, \"google.com\") of the Google Workspace customer that owns the organization.","readOnly":true,"type":"string"},"etag":{"description":"Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","readOnly":true,"type":"string"},"name":{"description":"Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is \"organizations/[organization_id]\". For example, \"organizations/1234\".","readOnly":true,"type":"string"},"state":{"description":"Output only. The organization's current lifecycle state.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","DELETE_REQUESTED"],"type":"string"},"updateTime":{"description":"Output only. Timestamp when the Organization was last modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_Policy":{"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).","type":"object","properties":{"auditConfigs":{"description":"Specifies cloud audit logging configuration for this policy.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_AuditConfig"}},"bindings":{"description":"Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Binding"}},"etag":{"description":"`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.","format":"byte","type":"string"},"version":{"description":"Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"cloudresourcemanager_v3_Project":{"description":"A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.","type":"object","properties":{"configuredCapabilities":{"description":"Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY.","readOnly":true,"type":"array","items":{"type":"string"}},"createTime":{"description":"Output only. Creation time.","format":"google-datetime","readOnly":true,"type":"string"},"deleteTime":{"description":"Output only. The time at which this resource was requested for deletion.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project`","type":"string"},"etag":{"description":"Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","readOnly":true,"type":"string"},"isManagementProject":{"description":"Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).","readOnly":true,"type":"boolean"},"labels":{"description":"Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `\"myBusinessDimension\" : \"businessValue\"`","type":"object","additionalProperties":{"type":"string"}},"name":{"description":"Output only. The unique resource name of the project. It is an int64 generated number prefixed by \"projects/\". Example: `projects/415104041262`","readOnly":true,"type":"string"},"parent":{"description":"Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`.","type":"string"},"projectId":{"description":"Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123`","type":"string"},"state":{"description":"Output only. The project lifecycle state.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","DELETE_REQUESTED"],"type":"string"},"tags":{"description":"Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.","type":"object","additionalProperties":{"type":"string"}},"updateTime":{"description":"Output only. The most recent time this resource was modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_ProjectCreationStatus":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.","type":"object","properties":{"createTime":{"description":"Creation time of the project creation workflow.","format":"google-datetime","type":"string"},"gettable":{"description":"True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.","type":"boolean"},"ready":{"description":"True if the project creation process is complete.","type":"boolean"}}},"cloudresourcemanager_v3_SearchFoldersResponse":{"description":"The response message for searching folders.","type":"object","properties":{"folders":{"description":"A possibly paginated folder search results. the specified parent resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}},"nextPageToken":{"description":"A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue.","type":"string"}}},"cloudresourcemanager_v3_SearchOrganizationsResponse":{"description":"The response returned from the `SearchOrganizations` method.","type":"object","properties":{"nextPageToken":{"description":"A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.","type":"string"},"organizations":{"description":"The list of Organizations that matched the search query, possibly paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Organization"}}}},"cloudresourcemanager_v3_SearchProjectsResponse":{"description":"A page of the response received from the SearchProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"projects":{"description":"The list of Projects that matched the list filter query. This list can be paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"cloudresourcemanager_v3_SetIamPolicyRequest":{"description":"Request message for `SetIamPolicy` method.","type":"object","properties":{"policy":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"},"updateMask":{"description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`","format":"google-fieldmask","type":"string"}}},"cloudresourcemanager_v3_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"cloudresourcemanager_v3_TagBinding":{"description":"A TagBinding represents a connection between a TagValue and a cloud resource. When a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.","type":"object","properties":{"name":{"description":"Output only. The name of the TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`) or `tagBindings/{full-resource-name}/{tag-key-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagKeys/123`).","readOnly":true,"type":"string"},"parent":{"description":"The full resource name of the resource the TagValue is bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`","type":"string"},"tagValue":{"description":"The TagValue of the TagBinding. Must be of the form `tagValues/456`.","type":"string"},"tagValueNamespacedName":{"description":"The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected.","type":"string"}}},"cloudresourcemanager_v3_TagBindingCollection":{"description":"Represents a collection of tags directly bound to a GCP resource.","type":"object","properties":{"etag":{"description":"Optional. A checksum based on the current bindings which can be passed to prevent race conditions. This field is always set in server responses.","type":"string"},"fullResourceName":{"description":"The full resource name of the resource the TagBindings are bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`","type":"string"},"name":{"description":"Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"tags":{"description":"Tag keys/values directly bound to this resource, specified in namespaced format. For example: \"123/environment\": \"production\"","type":"object","additionalProperties":{"type":"string"}}}},"cloudresourcemanager_v3_TagHold":{"description":"A TagHold represents the use of a TagValue that is not captured by TagBindings. If a TagValue has any TagHolds, deletion will be blocked. This resource is intended to be created in the same cloud location as the `holder`.","type":"object","properties":{"createTime":{"description":"Output only. The time this TagHold was created.","format":"google-datetime","readOnly":true,"type":"string"},"helpLink":{"description":"Optional. A URL where an end user can learn more about removing this hold. E.g. `https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing`","type":"string"},"holder":{"description":"Required. The name of the resource where the TagValue is being used. Must be less than 200 characters. E.g. `//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group`","type":"string"},"name":{"description":"Output only. The resource name of a TagHold. This is a String of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}` (e.g. `tagValues/123/tagHolds/456`). This resource name is generated by the server.","readOnly":true,"type":"string"},"origin":{"description":"Optional. An optional string representing the origin of this request. This field should include human-understandable information to distinguish origins from each other. Must be less than 200 characters. E.g. `migs-35678234`","type":"string"}}},"cloudresourcemanager_v3_TagKey":{"description":"A TagKey, used to group a set of TagValues.","type":"object","properties":{"allowedValuesRegex":{"description":"Optional. Regular expression constraint for freeform tag values. If present, it implicitly allows freeform values (constrained by the regex).","type":"string"},"createTime":{"description":"Output only. Creation time.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.","type":"string"},"etag":{"description":"Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.","type":"string"},"name":{"description":"Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey.","type":"string"},"namespacedName":{"description":"Output only. Immutable. Namespaced name of the TagKey.","readOnly":true,"type":"string"},"parent":{"description":"Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`.","type":"string"},"purpose":{"description":"Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.","enum":["PURPOSE_UNSPECIFIED","GCE_FIREWALL","DATA_GOVERNANCE"],"type":"string"},"purposeData":{"description":"Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.","type":"object","additionalProperties":{"type":"string"}},"shortName":{"description":"Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.","type":"string"},"updateTime":{"description":"Output only. Update time.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_TagValue":{"description":"A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.","type":"object","properties":{"createTime":{"description":"Output only. Creation time.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write.","type":"string"},"etag":{"description":"Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details.","type":"string"},"name":{"description":"Immutable. Resource name for TagValue in the format `tagValues/456`.","type":"string"},"namespacedName":{"description":"Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.","readOnly":true,"type":"string"},"parent":{"description":"Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form `tagKeys/{tag_key_id}`.","type":"string"},"shortName":{"description":"Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 256 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.","type":"string"},"updateTime":{"description":"Output only. Update time.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_TestIamPermissionsRequest":{"description":"Request message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).","type":"array","items":{"type":"string"}}}},"cloudresourcemanager_v3_TestIamPermissionsResponse":{"description":"Response message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"A subset of `TestPermissionsRequest.permissions` that the caller is allowed.","type":"array","items":{"type":"string"}}}},"cloudresourcemanager_v3_UndeleteFolderMetadata":{"description":"A status object which is used as the `metadata` field for the `Operation` returned by `UndeleteFolder`.","type":"object"},"cloudresourcemanager_v3_UndeleteFolderRequest":{"description":"The UndeleteFolder request message.","type":"object"},"cloudresourcemanager_v3_UndeleteOrganizationMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.","type":"object"},"cloudresourcemanager_v3_UndeleteProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by `UndeleteProject`.","type":"object"},"cloudresourcemanager_v3_UndeleteProjectRequest":{"description":"The request sent to the UndeleteProject method.","type":"object"},"cloudresourcemanager_v3_UpdateBoundaryConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateBoundaryConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_UpdateBoundaryMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateBoundary. Currently empty.","type":"object"},"cloudresourcemanager_v3_UpdateCapabilityConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateCapabilityConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_UpdateFolderMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.","type":"object"},"cloudresourcemanager_v3_UpdateProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateProject.","type":"object"},"cloudresourcemanager_v3_UpdateTagKeyMetadata":{"description":"Runtime operation information for updating a TagKey.","type":"object"},"cloudresourcemanager_v3_UpdateTagValueMetadata":{"description":"Runtime operation information for updating a TagValue.","type":"object"}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/cloud-platform":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/cloud-platform"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/cloudresourcemanager/v3/rest","service":"cloudresourcemanager","version":"v3"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Cloud Resource Manager API","version":"v3","description":"Creates, reads, and updates metadata for Google Cloud Platform resource containers."},"servers":[{"url":"https://cloudresourcemanager.googleapis.com/"}],"paths":{"/v3/effectiveTags":{"get":{"operationId":"cloudresourcemanager.effectiveTags.list","x-executor-toolPath":"cloudresourcemanager.effectiveTags.list","tags":["Cloud Resource Manager API"],"description":"Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of effective tags to return in the response. The server allows a maximum of 300 effective tags to return in a single page. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of effective tags to return in the response. The server allows a maximum of 300 effective tags to return in a single page. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListEffectiveTags` that indicates from where this listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListEffectiveTags` that indicates from where this listing should continue.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The full resource name of a resource for which you want to list the effective tags. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","schema":{"description":"Required. The full resource name of a resource for which you want to list the effective tags. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListEffectiveTagsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders":{"get":{"operationId":"cloudresourcemanager.folders.list","x-executor-toolPath":"cloudresourcemanager.folders.list","tags":["Cloud Resource Manager API"],"description":"Lists the folders that are direct descendants of supplied parent resource. `list()` provides a strongly consistent view of the folders underneath the specified parent resource. `list()` returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.","schema":{"description":"Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.","schema":{"description":"Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListFoldersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.folders.create","x-executor-toolPath":"cloudresourcemanager.folders.create","tags":["Cloud Resource Manager API"],"description":"Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track the progress of the folder creation workflow. Upon success, the `Operation.response` field will be populated with the created Folder. In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints. + The folder's `display_name` must be distinct from all other folders that share its parent. + The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the folder must not cause the total number of folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description. Other folder constraint violations will be communicated in the `Operation`, with the specific `PreconditionFailure` returned in the details list in the `Operation.error` field. The caller must have `resourcemanager.folders.create` permission on the identified parent.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}":{"get":{"operationId":"cloudresourcemanager.folders.get","x-executor-toolPath":"cloudresourcemanager.folders.get","tags":["Cloud Resource Manager API"],"description":"Retrieves a folder identified by the supplied resource name. Valid folder resource names have the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have `resourcemanager.folders.get` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to retrieve. Must be of the form `folders/{folder_id}`.","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to retrieve. Must be of the form `folders/{folder_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.folders.delete","x-executor-toolPath":"cloudresourcemanager.folders.delete","tags":["Cloud Resource Manager API"],"description":"Requests deletion of a folder. The folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the ACTIVE state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-op success. The caller must have `resourcemanager.folders.delete` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to be deleted. Must be of the form `folders/{folder_id}`.","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to be deleted. Must be of the form `folders/{folder_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.folders.patch","x-executor-toolPath":"cloudresourcemanager.folders.patch","tags":["Cloud Resource Manager API"],"description":"Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be rejected if they violate either the `display_name` formatting rules or the naming constraints described in the CreateFolder documentation. The folder's `display_name` must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\\p{L}\\p{N}{1,28}[\\p{L}\\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a `PreconditionFailure` explaining this violation will be returned in the Status.details field.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Fields to be updated. Only the `display_name` can be updated.","schema":{"description":"Required. Fields to be updated. Only the `display_name` can be updated.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}/capabilities/{capabilitiesId}":{"get":{"operationId":"cloudresourcemanager.folders.capabilities.get","x-executor-toolPath":"cloudresourcemanager.folders.capabilities.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the Capability identified by the supplied resource name.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","type":"string"},"allowReserved":true},{"name":"capabilitiesId","in":"path","required":true,"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","schema":{"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Required. The name of the capability to get. For example, `folders/123/capabilities/app-management`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Capability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.folders.capabilities.patch","x-executor-toolPath":"cloudresourcemanager.folders.capabilities.patch","tags":["Cloud Resource Manager API"],"description":"Updates the Capability.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","type":"string"},"allowReserved":true},{"name":"capabilitiesId","in":"path","required":true,"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","schema":{"description":"`capabilitiesId` of `name` (`folders/{foldersId}/capabilities/{capabilitiesId}`). Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update. Only [Capability.value] can be updated.","schema":{"description":"Optional. The list of fields to update. Only [Capability.value] can be updated.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Capability"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}/capabilityConfigs":{"get":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.list","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.list","tags":["Cloud Resource Manager API"],"description":"Lists CapabilityConfigs that are direct children of the specified organization, folder or project resource.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","schema":{"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","schema":{"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListCapabilityConfigsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.create","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.create","tags":["Cloud Resource Manager API"],"description":"Creates a CapabilityConfig under a parent Organization, Folder or Project. Creating a CapabilityConfig triggers the creation of a Management Project if one is not supplied.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","schema":{"description":"`foldersId` of `parent` (`folders/{foldersId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"capabilityConfigId","in":"query","required":false,"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","schema":{"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}":{"get":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.get","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.delete","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.delete","tags":["Cloud Resource Manager API"],"description":"Deletes the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.folders.capabilityConfigs.patch","x-executor-toolPath":"cloudresourcemanager.folders.capabilityConfigs.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name`, `types` and `boundaries` of the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`folders/{foldersId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update.","schema":{"description":"Optional. The list of fields to update.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.folders.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.folders.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the folder's resource name, for example: \"folders/1234\". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:move":{"post":{"operationId":"cloudresourcemanager.folders.move","x-executor-toolPath":"cloudresourcemanager.folders.move","tags":["Cloud Resource Manager API"],"description":"Moves a folder under a new resource parent. Returns an `Operation` which can be used to track the progress of the folder move workflow. Upon success, the `Operation.response` field will be populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the failure cause will be returned - if the failure occurs synchronously then the `FolderOperationError` will be returned in the `Status.details` field. If it occurs asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the Folder to move. Must be of the form folders/{folder_id}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_MoveFolderRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.folders.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.folders.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on a folder, replacing any existing policy. The `resource` field should be the folder's resource name, for example: \"folders/1234\". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.folders.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.folders.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified folder. The `resource` field should be the folder's resource name, for example: \"folders/1234\". There are no permissions required for making this API call.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`foldersId` of `resource` (`folders/{foldersId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders/{foldersId}:undelete":{"post":{"operationId":"cloudresourcemanager.folders.undelete","x-executor-toolPath":"cloudresourcemanager.folders.undelete","tags":["Cloud Resource Manager API"],"description":"Cancels the deletion request for a folder. This method may be called on a folder in any state. If the folder is in the ACTIVE state the result will be a no-op success. In order to succeed, the folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.undelete` permission on the identified folder.","parameters":[{"name":"foldersId","in":"path","required":true,"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to undelete. Must be of the form `folders/{folder_id}`.","schema":{"description":"`foldersId` of `name` (`folders/{foldersId}`). Required. The resource name of the folder to undelete. Must be of the form `folders/{folder_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_UndeleteFolderRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/folders:search":{"get":{"operationId":"cloudresourcemanager.folders.search","x-executor-toolPath":"cloudresourcemanager.folders.search","tags":["Cloud Resource Manager API"],"description":"Search for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The `displayName` field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. ``` | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | ``` Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\". * Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".","schema":{"description":"Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The `displayName` field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. ``` | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | ``` Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\". * Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SearchFoldersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/liens":{"get":{"operationId":"cloudresourcemanager.liens.list","x-executor-toolPath":"cloudresourcemanager.liens.list","tags":["Cloud Resource Manager API"],"description":"List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default.","schema":{"description":"The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The `next_page_token` value returned from a previous List request, if any.","schema":{"description":"The `next_page_token` value returned from a previous List request, if any.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The name of the resource to list all attached Liens. For example, `projects/1234`. (google.api.field_policy).resource_type annotation is not set since the parent depends on the meta api implementation. This field could be a project or other sub project resources.","schema":{"description":"Required. The name of the resource to list all attached Liens. For example, `projects/1234`. (google.api.field_policy).resource_type annotation is not set since the parent depends on the meta api implementation. This field could be a project or other sub project resources.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListLiensResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.liens.create","x-executor-toolPath":"cloudresourcemanager.liens.create","tags":["Cloud Resource Manager API"],"description":"Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/liens/{liensId}":{"get":{"operationId":"cloudresourcemanager.liens.get","x-executor-toolPath":"cloudresourcemanager.liens.get","tags":["Cloud Resource Manager API"],"description":"Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`","parameters":[{"name":"liensId","in":"path","required":true,"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien.","schema":{"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.liens.delete","x-executor-toolPath":"cloudresourcemanager.liens.delete","tags":["Cloud Resource Manager API"],"description":"Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`.","parameters":[{"name":"liensId","in":"path","required":true,"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien to delete.","schema":{"description":"`liensId` of `name` (`liens/{liensId}`). Required. The name/identifier of the Lien to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}":{"get":{"operationId":"cloudresourcemanager.locations.effectiveTagBindingCollections.get","x-executor-toolPath":"cloudresourcemanager.locations.effectiveTagBindingCollections.get","tags":["Cloud Resource Manager API"],"description":"Returns effective tag bindings on a GCP resource.","parameters":[{"name":"locationsId","in":"path","required":true,"description":"`locationsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`locationsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"effectiveTagBindingCollectionsId","in":"path","required":true,"description":"`effectiveTagBindingCollectionsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`effectiveTagBindingCollectionsId` of `name` (`locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}`). Required. The full name of the EffectiveTagBindingCollection in format: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_EffectiveTagBindingCollection"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}":{"get":{"operationId":"cloudresourcemanager.locations.tagBindingCollections.get","x-executor-toolPath":"cloudresourcemanager.locations.tagBindingCollections.get","tags":["Cloud Resource Manager API"],"description":"Returns tag bindings directly attached to a GCP resource.","parameters":[{"name":"locationsId","in":"path","required":true,"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"tagBindingCollectionsId","in":"path","required":true,"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Required. The full name of the TagBindingCollection in format: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the enoded-full-resource-name is the UTF-8 encoded name of the resource the TagBindings are bound to. E.g. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBindingCollection"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.locations.tagBindingCollections.patch","x-executor-toolPath":"cloudresourcemanager.locations.tagBindingCollections.patch","tags":["Cloud Resource Manager API"],"description":"Updates tag bindings directly attached to a GCP resource. Update_mask can be kept empty or \"*\".","parameters":[{"name":"locationsId","in":"path","required":true,"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`locationsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"tagBindingCollectionsId","in":"path","required":true,"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","schema":{"description":"`tagBindingCollectionsId` of `name` (`locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}`). Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. An update mask to selectively update fields.","schema":{"description":"Optional. An update mask to selectively update fields.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBindingCollection"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/operations/{operationsId}":{"get":{"operationId":"cloudresourcemanager.operations.get","x-executor-toolPath":"cloudresourcemanager.operations.get","tags":["Cloud Resource Manager API"],"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","parameters":[{"name":"operationsId","in":"path","required":true,"description":"`operationsId` of `name` (`operations/{operationsId}`). The name of the operation resource.","schema":{"description":"`operationsId` of `name` (`operations/{operationsId}`). The name of the operation resource.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}":{"get":{"operationId":"cloudresourcemanager.organizations.get","x-executor-toolPath":"cloudresourcemanager.organizations.get","tags":["Cloud Resource Manager API"],"description":"Fetches an organization resource identified by the specified resource name.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}`). Required. The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as \"organizations/[organizationId]\". For example, \"organizations/1234\".","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}`). Required. The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as \"organizations/[organizationId]\". For example, \"organizations/1234\".","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Organization"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}/capabilityConfigs":{"get":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.list","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.list","tags":["Cloud Resource Manager API"],"description":"Lists CapabilityConfigs that are direct children of the specified organization, folder or project resource.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","schema":{"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","schema":{"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListCapabilityConfigsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.create","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.create","tags":["Cloud Resource Manager API"],"description":"Creates a CapabilityConfig under a parent Organization, Folder or Project. Creating a CapabilityConfig triggers the creation of a Management Project if one is not supplied.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","schema":{"description":"`organizationsId` of `parent` (`organizations/{organizationsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"capabilityConfigId","in":"query","required":false,"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","schema":{"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}":{"get":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.get","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.delete","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.delete","tags":["Cloud Resource Manager API"],"description":"Deletes the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.organizations.capabilityConfigs.patch","x-executor-toolPath":"cloudresourcemanager.organizations.capabilityConfigs.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name`, `types` and `boundaries` of the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`organizationsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update.","schema":{"description":"Optional. The list of fields to update.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.organizations.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.organizations.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for an organization resource. The policy may be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, for example: \"organizations/123\". Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified organization.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.organizations.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.organizations.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: \"organizations/123\". Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified organization.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations/{organizationsId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.organizations.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.organizations.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns the permissions that a caller has on the specified organization. The `resource` field should be the organization's resource name, for example: \"organizations/123\". There are no permissions required for making this API call.","parameters":[{"name":"organizationsId","in":"path","required":true,"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`organizationsId` of `resource` (`organizations/{organizationsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/organizations:search":{"get":{"operationId":"cloudresourcemanager.organizations.search","x-executor-toolPath":"cloudresourcemanager.organizations.search","tags":["Cloud Resource Manager API"],"description":"Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear. Search will only return organizations on which the user has the permission `resourcemanager.organizations.get` or has super admin privileges.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to `SearchOrganizations` that indicates from where listing should continue.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.","schema":{"description":"Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SearchOrganizationsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects":{"get":{"operationId":"cloudresourcemanager.projects.list","x-executor-toolPath":"cloudresourcemanager.projects.list","tags":["Cloud Resource Manager API"],"description":"Lists projects that are direct children of the specified folder or organization resource. `list()` provides a strongly consistent view of the projects underneath the specified parent resource. `list()` returns projects sorted based upon the (ascending) lexical ordering of their `display_name`. The caller must have `resourcemanager.projects.list` permission on the identified parent.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`.","schema":{"description":"Required. The name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be returned. Normally only `ACTIVE` projects are returned.","schema":{"description":"Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be returned. Normally only `ACTIVE` projects are returned.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListProjectsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.projects.create","x-executor-toolPath":"cloudresourcemanager.projects.create","tags":["Cloud Resource Manager API"],"description":"Request that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}":{"get":{"operationId":"cloudresourcemanager.projects.get","x-executor-toolPath":"cloudresourcemanager.projects.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the project identified by the specified `name` (for example, `projects/415104041262`). The caller must have `resourcemanager.projects.get` permission for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`).","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.projects.delete","x-executor-toolPath":"cloudresourcemanager.projects.delete","tags":["Cloud Resource Manager API"],"description":"Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. The caller must have `resourcemanager.projects.delete` permissions for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the Project (for example, `projects/415104041262`).","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the Project (for example, `projects/415104041262`).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.projects.patch","x-executor-toolPath":"cloudresourcemanager.projects.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name` and labels of the project identified by the specified `name` (for example, `projects/415104041262`). Deleting all labels requires an update mask for labels field. The caller must have `resourcemanager.projects.update` permission for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Output only. The unique resource name of the project. It is an int64 generated number prefixed by \"projects/\". Example: `projects/415104041262`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Output only. The unique resource name of the project. It is an int64 generated number prefixed by \"projects/\". Example: `projects/415104041262`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. An update mask to selectively update fields.","schema":{"description":"Optional. An update mask to selectively update fields.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}/capabilityConfigs":{"get":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.list","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.list","tags":["Cloud Resource Manager API"],"description":"Lists CapabilityConfigs that are direct children of the specified organization, folder or project resource.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","schema":{"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The name of the parent resource whose CapabilityConfigs are being listed. Format: `organizations/{organization_id}` or `folders/{folder_id}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"Optional. The maximum number of CapabilityConfigs to return in the response. The service may return fewer CapabilityConfigs than requested. If unspecified, at most 100 CapabilityConfigs will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","schema":{"description":"Optional. A pagination token received from a previous call to `ListCapabilityConfigs` that indicates from where listing should continue. Provide this to retrieve the subsequent page.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListCapabilityConfigsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.create","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.create","tags":["Cloud Resource Manager API"],"description":"Creates a CapabilityConfig under a parent Organization, Folder or Project. Creating a CapabilityConfig triggers the creation of a Management Project if one is not supplied.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","schema":{"description":"`projectsId` of `parent` (`projects/{projectsId}`). Required. The parent resource under which the CapabilityConfig will be created. Format: `organizations/{organization_id}` or `folders/{folder_id}` or `projects/{project_number}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"capabilityConfigId","in":"query","required":false,"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","schema":{"description":"Required. The user-assigned ID for the CapabilityConfig, which will become the final component of the CapabilityConfig's resource name. Must be unique within the parent resource. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `my-capability-config-123`","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}":{"get":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.get","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.get","tags":["Cloud Resource Manager API"],"description":"Retrieves the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","schema":{"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to retrieve. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}` Example: `folders/123456789/capabilityConfigs/my-capability-config`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.delete","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.delete","tags":["Cloud Resource Manager API"],"description":"Deletes the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Required. The name of the CapabilityConfig to delete. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.projects.capabilityConfigs.patch","x-executor-toolPath":"cloudresourcemanager.projects.capabilityConfigs.patch","tags":["Cloud Resource Manager API"],"description":"Updates the `display_name`, `types` and `boundaries` of the CapabilityConfig identified by the specified `name` (for example, `folders/123456789/capabilityConfigs/my-capability-config`).","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"capabilityConfigsId","in":"path","required":true,"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","schema":{"description":"`capabilityConfigsId` of `name` (`projects/{projectsId}/capabilityConfigs/{capabilityConfigsId}`). Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. The list of fields to update.","schema":{"description":"Optional. The list of fields to update.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.projects.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.projects.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:move":{"post":{"operationId":"cloudresourcemanager.projects.move","x-executor-toolPath":"cloudresourcemanager.projects.move","tags":["Cloud Resource Manager API"],"description":"Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project to move.","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project to move.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_MoveProjectRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.projects.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.projects.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.projects.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.projects.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123..","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`projectsId` of `resource` (`projects/{projectsId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects/{projectsId}:undelete":{"post":{"operationId":"cloudresourcemanager.projects.undelete","x-executor-toolPath":"cloudresourcemanager.projects.undelete","tags":["Cloud Resource Manager API"],"description":"Restores the project identified by the specified `name` (for example, `projects/415104041262`). You can only use this method for a project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the project cannot be restored. The caller must have `resourcemanager.projects.undelete` permission for this project.","parameters":[{"name":"projectsId","in":"path","required":true,"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`). Required.","schema":{"description":"`projectsId` of `name` (`projects/{projectsId}`). Required. The name of the project (for example, `projects/415104041262`). Required.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_UndeleteProjectRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/projects:search":{"get":{"operationId":"cloudresourcemanager.projects.search","x-executor-toolPath":"cloudresourcemanager.projects.search","tags":["Cloud Resource Manager API"],"description":"Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","schema":{"description":"Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","schema":{"description":"Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":false,"description":"Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.","schema":{"description":"Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SearchProjectsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagBindings":{"get":{"operationId":"cloudresourcemanager.tagBindings.list","x-executor-toolPath":"cloudresourcemanager.tagBindings.list","tags":["Cloud Resource Manager API"],"description":"Lists the TagBindings for the given Google Cloud resource, as specified with `parent`. NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","schema":{"description":"Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. \"//cloudresourcemanager.googleapis.com/projects/123\"","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagBindingsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagBindings.create","x-executor-toolPath":"cloudresourcemanager.tagBindings.create","tags":["Cloud Resource Manager API"],"description":"Creates a TagBinding between a TagValue and a Google Cloud resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBinding"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagBindings/{tagBindingsId}":{"delete":{"operationId":"cloudresourcemanager.tagBindings.delete","x-executor-toolPath":"cloudresourcemanager.tagBindings.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagBinding.","parameters":[{"name":"tagBindingsId","in":"path","required":true,"description":"`tagBindingsId` of `name` (`tagBindings/{tagBindingsId}`). Required. The name of the TagBinding. This is a String of the form: `tagBindings/{id}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).","schema":{"description":"`tagBindingsId` of `name` (`tagBindings/{tagBindingsId}`). Required. The name of the TagBinding. This is a String of the form: `tagBindings/{id}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys":{"get":{"operationId":"cloudresourcemanager.tagKeys.list","x-executor-toolPath":"cloudresourcemanager.tagKeys.list","tags":["Cloud Resource Manager API"],"description":"Lists all TagKeys for a parent resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagKeys to return in the response. The server allows a maximum of 300 TagKeys to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagKeys to return in the response. The server allows a maximum of 300 TagKeys to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagKey` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagKey` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. The resource name of the TagKey's parent. Must be of the form `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`","schema":{"description":"Required. The resource name of the TagKey's parent. Must be of the form `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagKeysResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagKeys.create","x-executor-toolPath":"cloudresourcemanager.tagKeys.create","tags":["Cloud Resource Manager API"],"description":"Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/namespaced":{"get":{"operationId":"cloudresourcemanager.tagKeys.getNamespaced","x-executor-toolPath":"cloudresourcemanager.tagKeys.getNamespaced","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"name","in":"query","required":false,"description":"Required. A namespaced tag key name in the format `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name \"foo\" under the organization with ID 42 or `r2-d2/bar` for a key with short name \"bar\" under the project `r2-d2`.","schema":{"description":"Required. A namespaced tag key name in the format `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name \"foo\" under the organization with ID 42 or `r2-d2/bar` for a key with short name \"bar\" under the project `r2-d2`.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}":{"get":{"operationId":"cloudresourcemanager.tagKeys.get","x-executor-toolPath":"cloudresourcemanager.tagKeys.get","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.","schema":{"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.tagKeys.delete","x-executor-toolPath":"cloudresourcemanager.tagKeys.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.","schema":{"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"etag","in":"query","required":false,"description":"Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.","schema":{"description":"Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.","schema":{"description":"Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.tagKeys.patch","x-executor-toolPath":"cloudresourcemanager.tagKeys.patch","tags":["Cloud Resource Manager API"],"description":"Updates the attributes of the TagKey resource.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey.","schema":{"description":"`tagKeysId` of `name` (`tagKeys/{tagKeysId}`). Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Fields to be updated. The mask may only contain `description` or `etag`. If omitted entirely, both `description` and `etag` are assumed to be significant.","schema":{"description":"Fields to be updated. The mask may only contain `description` or `etag`. If omitted entirely, both `description` and `etag` are assumed to be significant.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Set as true to perform validations necessary for updating the resource, but not actually perform the action.","schema":{"description":"Set as true to perform validations necessary for updating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagKeys.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagKeys.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, \"tagKeys/1234\". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagKeys.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagKeys.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, \"tagKeys/1234\". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagKeys/{tagKeysId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.tagKeys.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.tagKeys.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, \"tagKeys/1234\". There are no permissions required for making this API call.","parameters":[{"name":"tagKeysId","in":"path","required":true,"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagKeysId` of `resource` (`tagKeys/{tagKeysId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues":{"get":{"operationId":"cloudresourcemanager.tagValues.list","x-executor-toolPath":"cloudresourcemanager.tagValues.list","tags":["Cloud Resource Manager API"],"description":"Lists all TagValues for a specific TagKey.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagValues to return in the response. The server allows a maximum of 300 TagValues to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagValues to return in the response. The server allows a maximum of 300 TagValues to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagValues` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagValues` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Required. Resource name for the parent of the TagValues to be listed, in the format `tagKeys/123` or `tagValues/123`.","schema":{"description":"Required. Resource name for the parent of the TagValues to be listed, in the format `tagKeys/123` or `tagValues/123`.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagValues.create","x-executor-toolPath":"cloudresourcemanager.tagValues.create","tags":["Cloud Resource Manager API"],"description":"Creates a TagValue as a child of the specified TagKey. If a another request with the same parameters is sent while the original request is in process the second request will receive an error. A maximum of 1000 TagValues can exist under a TagKey at any given time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set as true to perform the validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set as true to perform the validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/namespaced":{"get":{"operationId":"cloudresourcemanager.tagValues.getNamespaced","x-executor-toolPath":"cloudresourcemanager.tagValues.getNamespaced","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagValue by its namespaced name. This method will return `PERMISSION_DENIED` if the value does not exist or the user does not have permission to view it.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"name","in":"query","required":false,"description":"Required. A namespaced tag value name in the following format: `{parentId}/{tagKeyShort}/{tagValueShort}` Examples: - `42/foo/abc` for a value with short name \"abc\" under the key with short name \"foo\" under the organization with ID 42 - `r2-d2/bar/xyz` for a value with short name \"xyz\" under the key with short name \"bar\" under the project with ID \"r2-d2\"","schema":{"description":"Required. A namespaced tag value name in the following format: `{parentId}/{tagKeyShort}/{tagValueShort}` Examples: - `42/foo/abc` for a value with short name \"abc\" under the key with short name \"foo\" under the organization with ID 42 - `r2-d2/bar/xyz` for a value with short name \"xyz\" under the key with short name \"bar\" under the project with ID \"r2-d2\"","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}":{"get":{"operationId":"cloudresourcemanager.tagValues.get","x-executor-toolPath":"cloudresourcemanager.tagValues.get","tags":["Cloud Resource Manager API"],"description":"Retrieves a TagValue. This method will return `PERMISSION_DENIED` if the value does not exist or the user does not have permission to view it.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be fetched in the format `tagValues/456`.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be fetched in the format `tagValues/456`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"delete":{"operationId":"cloudresourcemanager.tagValues.delete","x-executor-toolPath":"cloudresourcemanager.tagValues.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be deleted in the format tagValues/456.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Required. Resource name for TagValue to be deleted in the format tagValues/456.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"etag","in":"query","required":false,"description":"Optional. The etag known to the client for the expected state of the TagValue. This is to be used for optimistic concurrency.","schema":{"description":"Optional. The etag known to the client for the expected state of the TagValue. This is to be used for optimistic concurrency.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set as true to perform the validations necessary for deletion, but not actually perform the action.","schema":{"description":"Optional. Set as true to perform the validations necessary for deletion, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]},"patch":{"operationId":"cloudresourcemanager.tagValues.patch","x-executor-toolPath":"cloudresourcemanager.tagValues.patch","tags":["Cloud Resource Manager API"],"description":"Updates the attributes of the TagValue resource.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Immutable. Resource name for TagValue in the format `tagValues/456`.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}`). Immutable. Resource name for TagValue in the format `tagValues/456`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Fields to be updated.","schema":{"description":"Optional. Fields to be updated.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. True to perform validations necessary for updating the resource, but not actually perform the action.","schema":{"description":"Optional. True to perform validations necessary for updating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}/tagHolds/{tagHoldsId}":{"delete":{"operationId":"cloudresourcemanager.tagValues.tagHolds.delete","x-executor-toolPath":"cloudresourcemanager.tagValues.tagHolds.delete","tags":["Cloud Resource Manager API"],"description":"Deletes a TagHold.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","schema":{"description":"`tagValuesId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","type":"string"},"allowReserved":true},{"name":"tagHoldsId","in":"path","required":true,"description":"`tagHoldsId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","schema":{"description":"`tagHoldsId` of `name` (`tagValues/{tagValuesId}/tagHolds/{tagHoldsId}`). Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform the validations necessary for deleting the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform the validations necessary for deleting the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}:getIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagValues.getIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagValues.getIamPolicy","tags":["Cloud Resource Manager API"],"description":"Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. The caller must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` permission on the identified TagValue to get the access control policy.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}:setIamPolicy":{"post":{"operationId":"cloudresourcemanager.tagValues.setIamPolicy","x-executor-toolPath":"cloudresourcemanager.tagValues.setIamPolicy","tags":["Cloud Resource Manager API"],"description":"Sets the access control policy on a TagValue, replacing any existing policy. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` permission on the identified tagValue.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/tagValues/{tagValuesId}:testIamPermissions":{"post":{"operationId":"cloudresourcemanager.tagValues.testIamPermissions","x-executor-toolPath":"cloudresourcemanager.tagValues.testIamPermissions","tags":["Cloud Resource Manager API"],"description":"Returns permissions that a caller has on the specified TagValue. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. There are no permissions required for making this API call.","parameters":[{"name":"tagValuesId","in":"path","required":true,"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","schema":{"description":"`tagValuesId` of `resource` (`tagValues/{tagValuesId}`). REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TestIamPermissionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3/{parent}/tagHolds":{"get":{"operationId":"cloudresourcemanager.tagValues.tagHolds.list","x-executor-toolPath":"cloudresourcemanager.tagValues.tagHolds.list","tags":["Cloud Resource Manager API"],"description":"Lists TagHolds under a TagValue.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","schema":{"description":"Required. The resource name of the parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the `holder` and `origin` fields are supported for filtering. Currently only `AND` syntax is supported. Some example queries are: * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` * `origin = 35678234` * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234`","schema":{"description":"Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the `holder` and `origin` fields are supported for filtering. Currently only `AND` syntax is supported. Some example queries are: * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` * `origin = 35678234` * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234`","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.","schema":{"description":"Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A pagination token returned from a previous call to `ListTagHolds` that indicates where this listing should continue from.","schema":{"description":"Optional. A pagination token returned from a previous call to `ListTagHolds` that indicates where this listing should continue from.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_ListTagHoldsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]},"post":{"operationId":"cloudresourcemanager.tagValues.tagHolds.create","x-executor-toolPath":"cloudresourcemanager.tagValues.tagHolds.create","tags":["Cloud Resource Manager API"],"description":"Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same resource and origin exists under the same TagValue.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The resource name of the TagHold's parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","schema":{"description":"Required. The resource name of the TagHold's parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"validateOnly","in":"query","required":false,"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","schema":{"description":"Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.","type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagHold"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform"]}},"/v3:fetchResourceSemantics":{"get":{"operationId":"cloudresourcemanager.fetchResourceSemantics","x-executor-toolPath":"cloudresourcemanager.fetchResourceSemantics","tags":["Cloud Resource Manager API"],"description":"Returns the semantics associated with the specified resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"fullResourceName","in":"query","required":false,"description":"Required. The full resource name of the GCP resource to retrieve semantics for. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"","schema":{"description":"Required. The full resource name of the GCP resource to retrieve semantics for. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudresourcemanager_v3_FetchResourceSemanticsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]},{"googleOAuth2":["https://www.googleapis.com/auth/cloud-platform"]}],"x-google-scopes":["https://www.googleapis.com/auth/cloud-platform.read-only","https://www.googleapis.com/auth/cloud-platform"]}}},"components":{"schemas":{"cloudresourcemanager_v3_AuditConfig":{"description":"Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.","type":"object","properties":{"auditLogConfigs":{"description":"The configuration for logging of each type of permission.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_AuditLogConfig"}},"service":{"description":"Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.","type":"string"}}},"cloudresourcemanager_v3_AuditLogConfig":{"description":"Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.","type":"object","properties":{"exemptedMembers":{"description":"Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.","type":"array","items":{"type":"string"}},"logType":{"description":"The log type that this config enables.","enum":["LOG_TYPE_UNSPECIFIED","ADMIN_READ","DATA_WRITE","DATA_READ"],"type":"string"}}},"cloudresourcemanager_v3_Binding":{"description":"Associates `members`, or principals, with a `role`.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Expr"},"members":{"description":"Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.","type":"array","items":{"type":"string"}},"role":{"description":"Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).","type":"string"}}},"cloudresourcemanager_v3_Capability":{"description":"Representation of a Capability.","type":"object","properties":{"name":{"description":"Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management`","type":"string"},"value":{"description":"Required. The configured value of the capability at the given parent resource.","type":"boolean"}}},"cloudresourcemanager_v3_CapabilityConfig":{"description":"A CapabilityConfig allows managing experiences like applications and agents on a logical administrative perimeter of Projects (Boundary).","type":"object","properties":{"boundaries":{"description":"Optional. The list of Boundaries associated with this CapabilityConfig. Format: `organizations/{organization}/boundaries/{boundary}` or, `folders/{folder}/boundaries/{boundary}` or, `projects/{project}/boundaries/{boundary}`","type":"array","items":{"type":"string"}},"createTime":{"description":"Output only. The creation time of the CapabilityConfig.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"Optional. Human-readable non-unique display name of the CapabilityConfig. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My CapabilityConfig`","type":"string"},"etag":{"description":"This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","type":"string"},"managementProject":{"description":"Optional. Immutable. The Management Project associated with this CapabilityConfig. If not provided during creation, a management project will be automatically created. Cannot be modified after creation. Format: `projects/{project_number}` Example: `projects/123456789012`","type":"string"},"name":{"description":"Identifier. The unique resource name of the CapabilityConfig. Format: `organizations/{organization}/capabilityConfigs/{capabilityConfig}` or, `folders/{folder}/capabilityConfigs/{capabilityConfig}` or, `projects/{project}/capabilityConfigs/{capabilityConfig}`","type":"string"},"state":{"description":"Output only. The lifecycle state of the CapabilityConfig.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE"],"type":"string"},"types":{"description":"Required. The CapabilityConfig types.","type":"array","items":{"enum":["TYPE_UNSPECIFIED","APP_MANAGEMENT","AGENT_MANAGEMENT"],"type":"string"}},"updateTime":{"description":"Output only. The most recent time this CapabilityConfig was modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation":{"description":"Metadata describing a long running folder operation","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization we are either creating the folder under or moving the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"operationType":{"description":"The type of this operation.","enum":["OPERATION_TYPE_UNSPECIFIED","CREATE","MOVE"],"type":"string"},"sourceParent":{"description":"The resource name of the folder's parent. Only applicable when the operation_type is MOVE.","type":"string"}}},"cloudresourcemanager_v3_CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation":{"description":"Metadata describing a long running folder operation","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization we are either creating the folder under or moving the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"operationType":{"description":"The type of this operation.","enum":["OPERATION_TYPE_UNSPECIFIED","CREATE","MOVE"],"type":"string"},"sourceParent":{"description":"The resource name of the folder's parent. Only applicable when the operation_type is MOVE.","type":"string"}}},"cloudresourcemanager_v3_CreateBoundaryMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateBoundary. Currently empty.","type":"object"},"cloudresourcemanager_v3_CreateCapabilityConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateCapabilityConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_CreateFolderMetadata":{"description":"Metadata pertaining to the Folder creation process.","type":"object","properties":{"displayName":{"description":"The display name of the folder.","type":"string"},"parent":{"description":"The resource name of the folder or organization we are creating the folder under.","type":"string"}}},"cloudresourcemanager_v3_CreateProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.","type":"object","properties":{"createTime":{"description":"Creation time of the project creation workflow.","format":"google-datetime","type":"string"},"gettable":{"description":"True if the project can be retrieved using `GetProject`. No other operations on the project are guaranteed to work until the project creation is complete.","type":"boolean"},"ready":{"description":"True if the project creation process is complete.","type":"boolean"}}},"cloudresourcemanager_v3_CreateTagBindingMetadata":{"description":"Runtime operation information for creating a TagValue.","type":"object"},"cloudresourcemanager_v3_CreateTagKeyMetadata":{"description":"Runtime operation information for creating a TagKey.","type":"object"},"cloudresourcemanager_v3_CreateTagValueMetadata":{"description":"Runtime operation information for creating a TagValue.","type":"object"},"cloudresourcemanager_v3_DeleteBoundaryMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by DeleteBoundary. Currently empty.","type":"object"},"cloudresourcemanager_v3_DeleteCapabilityConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by DeleteCapabilityConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_DeleteFolderMetadata":{"description":"A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.","type":"object"},"cloudresourcemanager_v3_DeleteOrganizationMetadata":{"description":"A status object which is used as the `metadata` field for the operation returned by DeleteOrganization.","type":"object"},"cloudresourcemanager_v3_DeleteProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by `DeleteProject`.","type":"object"},"cloudresourcemanager_v3_DeleteTagBindingMetadata":{"description":"Runtime operation information for deleting a TagBinding.","type":"object"},"cloudresourcemanager_v3_DeleteTagKeyMetadata":{"description":"Runtime operation information for deleting a TagKey.","type":"object"},"cloudresourcemanager_v3_DeleteTagValueMetadata":{"description":"Runtime operation information for deleting a TagValue.","type":"object"},"cloudresourcemanager_v3_EffectiveTag":{"description":"An EffectiveTag represents a tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. EffectiveTag contains the name and namespaced_name of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.","type":"object","properties":{"inherited":{"description":"Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.","type":"boolean"},"namespacedTagKey":{"description":"The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.","type":"string"},"namespacedTagValue":{"description":"The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.","type":"string"},"tagKey":{"description":"The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.","type":"string"},"tagKeyParentName":{"description":"The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`","type":"string"},"tagValue":{"description":"Resource name for TagValue in the format `tagValues/456`.","type":"string"}}},"cloudresourcemanager_v3_EffectiveTagBindingCollection":{"description":"Represents a collection of effective tag bindings for a GCP resource.","type":"object","properties":{"effectiveTags":{"description":"Tag keys/values effectively bound to this resource, specified in namespaced format. For example: \"123/environment\": \"production\"","type":"object","additionalProperties":{"type":"string"}},"fullResourceName":{"description":"The full resource name of the resource the TagBindings are bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`","type":"string"},"name":{"description":"Identifier. The name of the EffectiveTagBindingCollection, following the convention: `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. E.g. \"locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"}}},"cloudresourcemanager_v3_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"cloudresourcemanager_v3_Expr":{"description":"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.","type":"object","properties":{"description":{"description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.","type":"string"},"expression":{"description":"Textual representation of an expression in Common Expression Language syntax.","type":"string"},"location":{"description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.","type":"string"},"title":{"description":"Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.","type":"string"}}},"cloudresourcemanager_v3_FetchResourceSemanticsResponse":{"description":"Response message for FetchResourceSemantics.","type":"object","properties":{"fullResourceName":{"description":"The full resource name for which semantics are returned. Examples: \"//compute.googleapis.com/projects/123/zones/us-central1-a/instances/my-instance\" \"//storage.googleapis.com/projects/_/buckets/my_bucket\"","type":"string"},"semantics":{"description":"Map of resource semantics (e.g., `\"ENVIRONMENT\": \"PRODUCTION\"`).","type":"object","additionalProperties":{"type":"string"}}}},"cloudresourcemanager_v3_Folder":{"description":"A folder in an organization's resource hierarchy, used to organize that organization's resources.","type":"object","properties":{"configuredCapabilities":{"description":"Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`.","readOnly":true,"type":"array","items":{"type":"string"}},"createTime":{"description":"Output only. Timestamp when the folder was created.","format":"google-datetime","readOnly":true,"type":"string"},"deleteTime":{"description":"Output only. Timestamp when the folder was requested to be deleted.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\\p{L}\\p{N}]([\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?`.","type":"string"},"etag":{"description":"Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","readOnly":true,"type":"string"},"managementProject":{"description":"Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY.","readOnly":true,"type":"string"},"name":{"description":"Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".","type":"string"},"parent":{"description":"Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.","type":"string"},"state":{"description":"Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","DELETE_REQUESTED"],"type":"string"},"tags":{"description":"Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.","type":"object","additionalProperties":{"type":"string"}},"updateTime":{"description":"Output only. Timestamp when the folder was last modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_FolderOperation":{"description":"Metadata describing a long running folder operation","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization we are either creating the folder under or moving the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"operationType":{"description":"The type of this operation.","enum":["OPERATION_TYPE_UNSPECIFIED","CREATE","MOVE"],"type":"string"},"sourceParent":{"description":"The resource name of the folder's parent. Only applicable when the operation_type is MOVE.","type":"string"}}},"cloudresourcemanager_v3_FolderOperationError":{"description":"A classification of the Folder Operation error.","type":"object","properties":{"errorMessageId":{"description":"The type of operation error experienced.","enum":["ERROR_TYPE_UNSPECIFIED","ACTIVE_FOLDER_HEIGHT_VIOLATION","MAX_CHILD_FOLDERS_VIOLATION","FOLDER_NAME_UNIQUENESS_VIOLATION","RESOURCE_DELETED_VIOLATION","PARENT_DELETED_VIOLATION","CYCLE_INTRODUCED_VIOLATION","FOLDER_BEING_MOVED_VIOLATION","FOLDER_TO_DELETE_NON_EMPTY_VIOLATION","DELETED_FOLDER_HEIGHT_VIOLATION","FOLDER_TO_DELETE_CONFIGURED_CAPABILITY_VIOLATION"],"type":"string"}}},"cloudresourcemanager_v3_GetIamPolicyRequest":{"description":"Request message for `GetIamPolicy` method.","type":"object","properties":{"options":{"$ref":"#/components/schemas/cloudresourcemanager_v3_GetPolicyOptions"}}},"cloudresourcemanager_v3_GetPolicyOptions":{"description":"Encapsulates settings provided to GetIamPolicy.","type":"object","properties":{"requestedPolicyVersion":{"description":"Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"cloudresourcemanager_v3_Lien":{"description":"A Lien represents an encumbrance on the actions that can be performed on a resource.","type":"object","properties":{"createTime":{"description":"The creation time of this Lien.","format":"google-datetime","type":"string"},"name":{"description":"A system-generated unique identifier for this Lien. Example: `liens/1234abcd`","type":"string"},"origin":{"description":"A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com'","type":"string"},"parent":{"description":"A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234`","type":"string"},"reason":{"description":"Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key'","type":"string"},"restrictions":{"description":"The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete']","type":"array","items":{"type":"string"}}}},"cloudresourcemanager_v3_ListCapabilityConfigsResponse":{"description":"A page of the response received from the ListCapabilityConfigs method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next page. NOTE: A response may contain fewer elements than the request `page_size` and still have a `next_page_token`.","type":"object","properties":{"capabilityConfigs":{"description":"The list of CapabilityConfigs under the parent. This list can be paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_CapabilityConfig"}},"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.","type":"string"}}},"cloudresourcemanager_v3_ListEffectiveTagsResponse":{"description":"The response of ListEffectiveTags.","type":"object","properties":{"effectiveTags":{"description":"A possibly paginated list of effective tags for the specified resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_EffectiveTag"}},"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"}}},"cloudresourcemanager_v3_ListFoldersResponse":{"description":"The ListFolders response message.","type":"object","properties":{"folders":{"description":"A possibly paginated list of folders that are direct descendants of the specified parent resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}},"nextPageToken":{"description":"A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue.","type":"string"}}},"cloudresourcemanager_v3_ListLiensResponse":{"description":"The response message for Liens.ListLiens.","type":"object","properties":{"liens":{"description":"A list of Liens.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Lien"}},"nextPageToken":{"description":"Token to retrieve the next page of results, or empty if there are no more results in the list.","type":"string"}}},"cloudresourcemanager_v3_ListProjectsResponse":{"description":"A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page. NOTE: A response may contain fewer elements than the request `page_size` and still have a `next_page_token`.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"projects":{"description":"The list of Projects under the parent. This list can be paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"cloudresourcemanager_v3_ListTagBindingsResponse":{"description":"The ListTagBindings response.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"tagBindings":{"description":"A possibly paginated list of TagBindings for the specified resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagBinding"}}}},"cloudresourcemanager_v3_ListTagHoldsResponse":{"description":"The ListTagHolds response.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"tagHolds":{"description":"A possibly paginated list of TagHolds.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagHold"}}}},"cloudresourcemanager_v3_ListTagKeysResponse":{"description":"The ListTagKeys response message.","type":"object","properties":{"nextPageToken":{"description":"A pagination token returned from a previous call to `ListTagKeys` that indicates from where listing should continue.","type":"string"},"tagKeys":{"description":"List of TagKeys that live under the specified parent in the request.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagKey"}}}},"cloudresourcemanager_v3_ListTagValuesResponse":{"description":"The ListTagValues response.","type":"object","properties":{"nextPageToken":{"description":"A pagination token returned from a previous call to `ListTagValues` that indicates from where listing should continue.","type":"string"},"tagValues":{"description":"A possibly paginated list of TagValues that are direct descendants of the specified parent TagKey.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_TagValue"}}}},"cloudresourcemanager_v3_MoveFolderMetadata":{"description":"Metadata pertaining to the folder move process.","type":"object","properties":{"destinationParent":{"description":"The resource name of the folder or organization to move the folder to.","type":"string"},"displayName":{"description":"The display name of the folder.","type":"string"},"sourceParent":{"description":"The resource name of the folder's parent.","type":"string"}}},"cloudresourcemanager_v3_MoveFolderRequest":{"description":"The MoveFolder request message.","type":"object","properties":{"destinationParent":{"description":"Required. The resource name of the folder or organization which should be the folder's new parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.","type":"string"}}},"cloudresourcemanager_v3_MoveProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by MoveProject.","type":"object"},"cloudresourcemanager_v3_MoveProjectRequest":{"description":"The request sent to MoveProject method.","type":"object","properties":{"destinationParent":{"description":"Required. The new parent to move the Project under.","type":"string"}}},"cloudresourcemanager_v3_Operation":{"description":"This resource represents a long-running operation that is the result of a network API call.","type":"object","properties":{"done":{"description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.","type":"boolean"},"error":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Status"},"metadata":{"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}},"name":{"description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.","type":"string"},"response":{"description":"The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}}},"cloudresourcemanager_v3_Organization":{"description":"The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.","type":"object","properties":{"createTime":{"description":"Output only. Timestamp when the Organization was created.","format":"google-datetime","readOnly":true,"type":"string"},"deleteTime":{"description":"Output only. Timestamp when the Organization was requested for deletion.","format":"google-datetime","readOnly":true,"type":"string"},"directoryCustomerId":{"description":"Immutable. The G Suite / Workspace customer id used in the Directory API.","type":"string"},"displayName":{"description":"Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, \"google.com\") of the Google Workspace customer that owns the organization.","readOnly":true,"type":"string"},"etag":{"description":"Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","readOnly":true,"type":"string"},"name":{"description":"Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is \"organizations/[organization_id]\". For example, \"organizations/1234\".","readOnly":true,"type":"string"},"state":{"description":"Output only. The organization's current lifecycle state.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","DELETE_REQUESTED"],"type":"string"},"updateTime":{"description":"Output only. Timestamp when the Organization was last modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_Policy":{"description":"An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).","type":"object","properties":{"auditConfigs":{"description":"Specifies cloud audit logging configuration for this policy.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_AuditConfig"}},"bindings":{"description":"Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Binding"}},"etag":{"description":"`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.","format":"byte","type":"string"},"version":{"description":"Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).","format":"int32","type":"integer"}}},"cloudresourcemanager_v3_Project":{"description":"A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.","type":"object","properties":{"configuredCapabilities":{"description":"Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY.","readOnly":true,"type":"array","items":{"type":"string"}},"createTime":{"description":"Output only. Creation time.","format":"google-datetime","readOnly":true,"type":"string"},"deleteTime":{"description":"Output only. The time at which this resource was requested for deletion.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project`","type":"string"},"etag":{"description":"Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.","readOnly":true,"type":"string"},"isManagementProject":{"description":"Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).","readOnly":true,"type":"boolean"},"labels":{"description":"Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `\"myBusinessDimension\" : \"businessValue\"`","type":"object","additionalProperties":{"type":"string"}},"name":{"description":"Output only. The unique resource name of the project. It is an int64 generated number prefixed by \"projects/\". Example: `projects/415104041262`","readOnly":true,"type":"string"},"parent":{"description":"Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`.","type":"string"},"projectId":{"description":"Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123`","type":"string"},"state":{"description":"Output only. The project lifecycle state.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","DELETE_REQUESTED"],"type":"string"},"tags":{"description":"Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\" Note: Currently this field is in Preview.","type":"object","additionalProperties":{"type":"string"}},"updateTime":{"description":"Output only. The most recent time this resource was modified.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_ProjectCreationStatus":{"description":"A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.","type":"object","properties":{"createTime":{"description":"Creation time of the project creation workflow.","format":"google-datetime","type":"string"},"gettable":{"description":"True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.","type":"boolean"},"ready":{"description":"True if the project creation process is complete.","type":"boolean"}}},"cloudresourcemanager_v3_SearchFoldersResponse":{"description":"The response message for searching folders.","type":"object","properties":{"folders":{"description":"A possibly paginated folder search results. the specified parent resource.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Folder"}},"nextPageToken":{"description":"A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue.","type":"string"}}},"cloudresourcemanager_v3_SearchOrganizationsResponse":{"description":"The response returned from the `SearchOrganizations` method.","type":"object","properties":{"nextPageToken":{"description":"A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.","type":"string"},"organizations":{"description":"The list of Organizations that matched the search query, possibly paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Organization"}}}},"cloudresourcemanager_v3_SearchProjectsResponse":{"description":"A page of the response received from the SearchProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.","type":"object","properties":{"nextPageToken":{"description":"Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.","type":"string"},"projects":{"description":"The list of Projects that matched the list filter query. This list can be paginated.","type":"array","items":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Project"}}}},"cloudresourcemanager_v3_SetIamPolicyRequest":{"description":"Request message for `SetIamPolicy` method.","type":"object","properties":{"policy":{"$ref":"#/components/schemas/cloudresourcemanager_v3_Policy"},"updateMask":{"description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`","format":"google-fieldmask","type":"string"}}},"cloudresourcemanager_v3_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"cloudresourcemanager_v3_TagBinding":{"description":"A TagBinding represents a connection between a TagValue and a cloud resource. When a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.","type":"object","properties":{"name":{"description":"Output only. The name of the TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`) or `tagBindings/{full-resource-name}/{tag-key-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagKeys/123`).","readOnly":true,"type":"string"},"parent":{"description":"The full resource name of the resource the TagValue is bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`","type":"string"},"tagValue":{"description":"The TagValue of the TagBinding. Must be of the form `tagValues/456`.","type":"string"},"tagValueNamespacedName":{"description":"The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected.","type":"string"}}},"cloudresourcemanager_v3_TagBindingCollection":{"description":"Represents a collection of tags directly bound to a GCP resource.","type":"object","properties":{"etag":{"description":"Optional. A checksum based on the current bindings which can be passed to prevent race conditions. This field is always set in server responses.","type":"string"},"fullResourceName":{"description":"The full resource name of the resource the TagBindings are bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`","type":"string"},"name":{"description":"Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. \"locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123\"","type":"string"},"tags":{"description":"Tag keys/values directly bound to this resource, specified in namespaced format. For example: \"123/environment\": \"production\"","type":"object","additionalProperties":{"type":"string"}}}},"cloudresourcemanager_v3_TagHold":{"description":"A TagHold represents the use of a TagValue that is not captured by TagBindings. If a TagValue has any TagHolds, deletion will be blocked. This resource is intended to be created in the same cloud location as the `holder`.","type":"object","properties":{"createTime":{"description":"Output only. The time this TagHold was created.","format":"google-datetime","readOnly":true,"type":"string"},"helpLink":{"description":"Optional. A URL where an end user can learn more about removing this hold. E.g. `https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing`","type":"string"},"holder":{"description":"Required. The name of the resource where the TagValue is being used. Must be less than 200 characters. E.g. `//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group`","type":"string"},"name":{"description":"Output only. The resource name of a TagHold. This is a String of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}` (e.g. `tagValues/123/tagHolds/456`). This resource name is generated by the server.","readOnly":true,"type":"string"},"origin":{"description":"Optional. An optional string representing the origin of this request. This field should include human-understandable information to distinguish origins from each other. Must be less than 200 characters. E.g. `migs-35678234`","type":"string"}}},"cloudresourcemanager_v3_TagKey":{"description":"A TagKey, used to group a set of TagValues.","type":"object","properties":{"allowedValuesRegex":{"description":"Optional. Regular expression constraint for freeform tag values. If present, it implicitly allows freeform values (constrained by the regex).","type":"string"},"createTime":{"description":"Output only. Creation time.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.","type":"string"},"etag":{"description":"Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.","type":"string"},"name":{"description":"Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey.","type":"string"},"namespacedName":{"description":"Output only. Immutable. Namespaced name of the TagKey.","readOnly":true,"type":"string"},"parent":{"description":"Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`.","type":"string"},"purpose":{"description":"Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.","enum":["PURPOSE_UNSPECIFIED","GCE_FIREWALL","DATA_GOVERNANCE"],"type":"string"},"purposeData":{"description":"Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.","type":"object","additionalProperties":{"type":"string"}},"shortName":{"description":"Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.","type":"string"},"updateTime":{"description":"Output only. Update time.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_TagValue":{"description":"A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.","type":"object","properties":{"createTime":{"description":"Output only. Creation time.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write.","type":"string"},"etag":{"description":"Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details.","type":"string"},"name":{"description":"Immutable. Resource name for TagValue in the format `tagValues/456`.","type":"string"},"namespacedName":{"description":"Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.","readOnly":true,"type":"string"},"parent":{"description":"Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form `tagKeys/{tag_key_id}`.","type":"string"},"shortName":{"description":"Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 256 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.","type":"string"},"updateTime":{"description":"Output only. Update time.","format":"google-datetime","readOnly":true,"type":"string"}}},"cloudresourcemanager_v3_TestIamPermissionsRequest":{"description":"Request message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).","type":"array","items":{"type":"string"}}}},"cloudresourcemanager_v3_TestIamPermissionsResponse":{"description":"Response message for `TestIamPermissions` method.","type":"object","properties":{"permissions":{"description":"A subset of `TestPermissionsRequest.permissions` that the caller is allowed.","type":"array","items":{"type":"string"}}}},"cloudresourcemanager_v3_UndeleteFolderMetadata":{"description":"A status object which is used as the `metadata` field for the `Operation` returned by `UndeleteFolder`.","type":"object"},"cloudresourcemanager_v3_UndeleteFolderRequest":{"description":"The UndeleteFolder request message.","type":"object"},"cloudresourcemanager_v3_UndeleteOrganizationMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.","type":"object"},"cloudresourcemanager_v3_UndeleteProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by `UndeleteProject`.","type":"object"},"cloudresourcemanager_v3_UndeleteProjectRequest":{"description":"The request sent to the UndeleteProject method.","type":"object"},"cloudresourcemanager_v3_UpdateBoundaryConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateBoundaryConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_UpdateBoundaryMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateBoundary. Currently empty.","type":"object"},"cloudresourcemanager_v3_UpdateCapabilityConfigMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateCapabilityConfig. Currently empty.","type":"object"},"cloudresourcemanager_v3_UpdateFolderMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.","type":"object"},"cloudresourcemanager_v3_UpdateProjectMetadata":{"description":"A status object which is used as the `metadata` field for the Operation returned by UpdateProject.","type":"object"},"cloudresourcemanager_v3_UpdateTagKeyMetadata":{"description":"Runtime operation information for updating a TagKey.","type":"object"},"cloudresourcemanager_v3_UpdateTagValueMetadata":{"description":"Runtime operation information for updating a TagValue.","type":"object"}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/cloud-platform":"See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.","https://www.googleapis.com/auth/cloud-platform.read-only":"View your data across Google Cloud services and see the email address of your Google Account"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/cloud-platform"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/cloudresourcemanager/v3/rest","service":"cloudresourcemanager","version":"v3"}]}} \ No newline at end of file diff --git a/public/specs/google/google-docs.json b/public/specs/google/google-docs.json index aee281c7..a7f81c0a 100644 --- a/public/specs/google/google-docs.json +++ b/public/specs/google/google-docs.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Docs API","version":"v1","description":"Reads and writes Google Docs documents."},"servers":[{"url":"https://docs.googleapis.com/"}],"paths":{"/v1/documents":{"post":{"operationId":"docs.documents.create","x-executor-toolPath":"docs.documents.create","tags":["Google Docs API"],"description":"Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_Document"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_Document"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/documents"]}],"x-google-scopes":["https://www.googleapis.com/auth/documents"]}},"/v1/documents/{documentId}":{"get":{"operationId":"docs.documents.get","x-executor-toolPath":"docs.documents.get","tags":["Google Docs API"],"description":"Gets the latest version of the specified document.","parameters":[{"name":"documentId","in":"path","required":true,"description":"The ID of the document to retrieve.","schema":{"description":"The ID of the document to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to `true` or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. [Developer Preview](https://developers.google.com/workspace/preview).","schema":{"description":"The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to `true` or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeTabsContent","in":"query","required":false,"description":"Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content populates in the `Document.tabs` field instead of the text content fields in `Document`. - When `false`: The content of the document's first tab populates the content fields in `Document` excluding `Document.tabs`. If a document has only one tab, then that tab is used to populate the document content. `Document.tabs` will be empty. If you use a field mask that references the `Document.tabs` field (or any subfield), the API implicitly treats the request as if you set `include_tabs_content` to `true`.","schema":{"description":"Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content populates in the `Document.tabs` field instead of the text content fields in `Document`. - When `false`: The content of the document's first tab populates the content fields in `Document` excluding `Document.tabs`. If a document has only one tab, then that tab is used to populate the document content. `Document.tabs` will be empty. If you use a field mask that references the `Document.tabs` field (or any subfield), the API implicitly treats the request as if you set `include_tabs_content` to `true`.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"suggestionsViewMode","in":"query","required":false,"description":"The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.","schema":{"description":"The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.","enum":["DEFAULT_FOR_CURRENT_ACCESS","SUGGESTIONS_INLINE","PREVIEW_SUGGESTIONS_ACCEPTED","PREVIEW_WITHOUT_SUGGESTIONS"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_Document"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/documents"]}],"x-google-scopes":["https://www.googleapis.com/auth/documents"]}},"/v1/documents/{documentId}:batchUpdate":{"post":{"operationId":"docs.documents.batchUpdate","x-executor-toolPath":"docs.documents.batchUpdate","tags":["Google Docs API"],"description":"Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.","parameters":[{"name":"documentId","in":"path","required":true,"description":"The ID of the document to update.","schema":{"description":"The ID of the document to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_BatchUpdateDocumentRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_BatchUpdateDocumentResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/documents"]}],"x-google-scopes":["https://www.googleapis.com/auth/documents"]}}},"components":{"schemas":{"docs_v1_AcceptSuggestionRequest":{"description":"Accepts a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"suggestionId":{"description":"The ID of the suggestion.","type":"string"}}},"docs_v1_AddCommentReplyRequest":{"description":"Inserts a reply Post into a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread to add the reply to.","type":"string"},"post":{"$ref":"#/components/schemas/docs_v1_Post"},"suggestionId":{"description":"The ID of the SuggestionThread to add the reply to.","type":"string"}}},"docs_v1_AddCommentReplyResponse":{"description":"Response message for adding a reply. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"post":{"$ref":"#/components/schemas/docs_v1_Post"}}},"docs_v1_AddDocumentTabRequest":{"description":"Adds a document tab. When a tab is added at a given index, all subsequent tabs' indexes are incremented.","type":"object","properties":{"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_AddDocumentTabResponse":{"description":"The result of adding a document tab.","type":"object","properties":{"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_AutoText":{"description":"A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this AutoText, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"},"type":{"description":"The type of this auto text.","enum":["TYPE_UNSPECIFIED","PAGE_NUMBER","PAGE_COUNT"],"type":"string"}}},"docs_v1_Background":{"description":"Represents the background of a document.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"}}},"docs_v1_BackgroundSuggestionState":{"description":"A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates whether the current background color has been modified in this suggestion.","type":"boolean"}}},"docs_v1_BatchUpdateDocumentRequest":{"description":"Request message for BatchUpdateDocument.","type":"object","properties":{"requests":{"description":"A list of updates to apply to the document.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Request"}},"writeControl":{"$ref":"#/components/schemas/docs_v1_WriteControl"}}},"docs_v1_BatchUpdateDocumentResponse":{"description":"Response message from a BatchUpdateDocument request.","type":"object","properties":{"commentUpdateState":{"description":"Whether comment updates were applied in the batch request. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENT_UPDATE_STATE_UNSPECIFIED","NO_UPDATES_REQUESTED","ALL_SAVED","ALL_FAILED_UNKNOWN_REASON"],"type":"string"},"documentId":{"description":"The ID of the document to which the updates were applied to.","type":"string"},"replies":{"description":"The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Response"}},"suggestionResponses":{"description":"The suggestions which were affected by each update. This maps 1:1 with the updates. [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/docs_v1_SuggestionResponse"}},"writeControl":{"$ref":"#/components/schemas/docs_v1_WriteControl"}}},"docs_v1_Body":{"description":"The document body. The body typically contains the full document contents except for headers, footers, and footnotes.","type":"object","properties":{"content":{"description":"The contents of the body. The indexes for the body's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}}}},"docs_v1_BookmarkLink":{"description":"A reference to a bookmark in this document.","type":"object","properties":{"id":{"description":"The ID of a bookmark in this document.","type":"string"},"tabId":{"description":"The ID of the tab containing this bookmark.","type":"string"}}},"docs_v1_Bullet":{"description":"Describes the bullet of a paragraph.","type":"object","properties":{"listId":{"description":"The ID of the list this paragraph belongs to.","type":"string"},"nestingLevel":{"description":"The nesting level of this paragraph in the list.","format":"int32","type":"integer"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_BulletSuggestionState":{"description":"A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"listIdSuggested":{"description":"Indicates if there was a suggested change to the list_id.","type":"boolean"},"nestingLevelSuggested":{"description":"Indicates if there was a suggested change to the nesting_level.","type":"boolean"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_Color":{"description":"A solid color.","type":"object","properties":{"rgbColor":{"$ref":"#/components/schemas/docs_v1_RgbColor"}}},"docs_v1_ColumnBreak":{"description":"A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this ColumnBreak, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_CommentAnchor":{"description":"One or more locations in the document that are tied to CommentThreads with the same anchorId. Note: Multiple anchors may refer to the same location. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"The ID of the comment anchor.","type":"string"},"ranges":{"description":"A collection of Ranges in the document which are tied to this anchor.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Range"}}}},"docs_v1_CommentThread":{"description":"Represents a single comment thread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"The ID of the CommentAnchor in the document that this thread is tied to. Multiple comment threads may be anchored to the same CommentAnchor.","type":"string"},"commentId":{"description":"The unique ID of the comment thread.","type":"string"},"headPost":{"$ref":"#/components/schemas/docs_v1_Post"},"plainTextQuote":{"description":"The quoted text from the document when the comment was created, formatted as plain-text.","type":"string"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Post"}},"status":{"description":"Whether the thread is open or resolved.","enum":["STATUS_UNSPECIFIED","OPEN","RESOLVED"],"type":"string"}}},"docs_v1_CreateDropdownDefinitionRequest":{"description":"Creates a new DropdownDefinition in the document.","type":"object","properties":{"dropdownDefinition":{"$ref":"#/components/schemas/docs_v1_DropdownDefinition"},"tabId":{"description":"The ID of the tab to create the dropdown definition in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_CreateDropdownDefinitionResponse":{"description":"Response message for creating a dropdown definition.","type":"object","properties":{"dropdownDefinition":{"$ref":"#/components/schemas/docs_v1_DropdownDefinition"}}},"docs_v1_CreateFooterRequest":{"description":"Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned.","type":"object","properties":{"sectionBreakLocation":{"$ref":"#/components/schemas/docs_v1_Location"},"type":{"description":"The type of footer to create.","enum":["HEADER_FOOTER_TYPE_UNSPECIFIED","DEFAULT"],"type":"string"}}},"docs_v1_CreateFooterResponse":{"description":"The result of creating a footer.","type":"object","properties":{"footerId":{"description":"The ID of the created footer.","type":"string"}}},"docs_v1_CreateFootnoteRequest":{"description":"Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_CreateFootnoteResponse":{"description":"The result of creating a footnote.","type":"object","properties":{"footnoteId":{"description":"The ID of the created footnote.","type":"string"}}},"docs_v1_CreateHeaderRequest":{"description":"Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.","type":"object","properties":{"sectionBreakLocation":{"$ref":"#/components/schemas/docs_v1_Location"},"type":{"description":"The type of header to create.","enum":["HEADER_FOOTER_TYPE_UNSPECIFIED","DEFAULT"],"type":"string"}}},"docs_v1_CreateHeaderResponse":{"description":"The result of creating a header.","type":"object","properties":{"headerId":{"description":"The ID of the created header.","type":"string"}}},"docs_v1_CreateNamedRangeRequest":{"description":"Creates a NamedRange referencing the given range.","type":"object","properties":{"name":{"description":"The name of the NamedRange. Names do not need to be unique. Names must be at least 1 character and no more than 256 characters, measured in UTF-16 code units.","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_CreateNamedRangeResponse":{"description":"The result of creating a named range.","type":"object","properties":{"namedRangeId":{"description":"The ID of the created named range.","type":"string"}}},"docs_v1_CreateParagraphBulletsRequest":{"description":"Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list.","type":"object","properties":{"bulletPreset":{"description":"The kinds of bullet glyphs to be used.","enum":["BULLET_GLYPH_PRESET_UNSPECIFIED","BULLET_DISC_CIRCLE_SQUARE","BULLET_DIAMONDX_ARROW3D_SQUARE","BULLET_CHECKBOX","BULLET_ARROW_DIAMOND_DISC","BULLET_STAR_CIRCLE_SQUARE","BULLET_ARROW3D_CIRCLE_SQUARE","BULLET_LEFTTRIANGLE_DIAMOND_DISC","BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE","BULLET_DIAMOND_CIRCLE_SQUARE","NUMBERED_DECIMAL_ALPHA_ROMAN","NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS","NUMBERED_DECIMAL_NESTED","NUMBERED_UPPERALPHA_ALPHA_ROMAN","NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL","NUMBERED_ZERODECIMAL_ALPHA_ROMAN"],"type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_CropProperties":{"description":"The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angles are 0, the image is not cropped.","type":"object","properties":{"angle":{"description":"The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.","format":"float","type":"number"},"offsetBottom":{"description":"The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.","format":"float","type":"number"},"offsetLeft":{"description":"The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.","format":"float","type":"number"},"offsetRight":{"description":"The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.","format":"float","type":"number"},"offsetTop":{"description":"The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.","format":"float","type":"number"}}},"docs_v1_CropPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"angleSuggested":{"description":"Indicates if there was a suggested change to angle.","type":"boolean"},"offsetBottomSuggested":{"description":"Indicates if there was a suggested change to offset_bottom.","type":"boolean"},"offsetLeftSuggested":{"description":"Indicates if there was a suggested change to offset_left.","type":"boolean"},"offsetRightSuggested":{"description":"Indicates if there was a suggested change to offset_right.","type":"boolean"},"offsetTopSuggested":{"description":"Indicates if there was a suggested change to offset_top.","type":"boolean"}}},"docs_v1_DateElement":{"description":"A date instance mentioned in a document.","type":"object","properties":{"dateElementProperties":{"$ref":"#/components/schemas/docs_v1_DateElementProperties"},"dateId":{"description":"Output only. The unique ID of this date.","readOnly":true,"type":"string"},"suggestedDateElementPropertiesChanges":{"description":"The suggested changes to the date element properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDateElementProperties"}},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this DateElement, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_DateElementProperties":{"description":"Properties of a DateElement.","type":"object","properties":{"dateFormat":{"description":"Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent.","enum":["DATE_FORMAT_UNSPECIFIED","DATE_FORMAT_CUSTOM","DATE_FORMAT_MONTH_DAY_ABBREVIATED","DATE_FORMAT_MONTH_DAY_FULL","DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED","DATE_FORMAT_ISO8601"],"type":"string"},"displayText":{"description":"Output only. Indicates how the DateElement is displayed in the document.","type":"string"},"locale":{"description":"The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`.","type":"string"},"timeFormat":{"description":"Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.","enum":["TIME_FORMAT_UNSPECIFIED","TIME_FORMAT_DISABLED","TIME_FORMAT_HOUR_MINUTE","TIME_FORMAT_HOUR_MINUTE_TIMEZONE"],"type":"string"},"timeZoneId":{"description":"The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`.","type":"string"},"timestamp":{"description":"The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.","format":"google-datetime","type":"string"}}},"docs_v1_DateElementPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"dateFormatSuggested":{"description":"Indicates if there was a suggested change to date_format.","type":"boolean"},"localeSuggested":{"description":"Indicates if there was a suggested change to locale.","type":"boolean"},"timeFormatSuggested":{"description":"Indicates if there was a suggested change to time_format.","type":"boolean"},"timeZoneIdSuggested":{"description":"Indicates if there was a suggested change to time_zone_id.","type":"boolean"},"timestampSuggested":{"description":"Indicates if there was a suggested change to timestamp.","type":"boolean"}}},"docs_v1_DeleteCommentReplyRequest":{"description":"Deletes a reply Post from a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains an action. - The reply post contains an assignee. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"postId":{"description":"The ID of the reply Post being deleted.","type":"string"},"suggestionId":{"description":"The ID of the SuggestionThread which the post belongs to.","type":"string"}}},"docs_v1_DeleteCommentRequest":{"description":"Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread that is being deleted.","type":"string"}}},"docs_v1_DeleteContentRangeRequest":{"description":"Deletes content from the document.","type":"object","properties":{"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_DeleteDropdownDefinitionRequest":{"description":"Deletes a DropdownDefinition. If the dropdown definition is referenced by any dropdown instances (chips) in the document, a 400 bad request error is returned.","type":"object","properties":{"dropdownDefinitionId":{"description":"The ID of the DropdownDefinition to delete.","type":"string"},"tabId":{"description":"The ID of the tab that contains the dropdown definition to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteFooterRequest":{"description":"Deletes a Footer from the document.","type":"object","properties":{"footerId":{"description":"The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section.","type":"string"},"tabId":{"description":"The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteHeaderRequest":{"description":"Deletes a Header from the document.","type":"object","properties":{"headerId":{"description":"The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section.","type":"string"},"tabId":{"description":"The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteNamedRangeRequest":{"description":"Deletes a NamedRange.","type":"object","properties":{"name":{"description":"The name of the range(s) to delete. All named ranges with the given name will be deleted.","type":"string"},"namedRangeId":{"description":"The ID of the named range to delete.","type":"string"},"tabsCriteria":{"$ref":"#/components/schemas/docs_v1_TabsCriteria"}}},"docs_v1_DeleteParagraphBulletsRequest":{"description":"Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.","type":"object","properties":{"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_DeletePositionedObjectRequest":{"description":"Deletes a PositionedObject from the document.","type":"object","properties":{"objectId":{"description":"The ID of the positioned object to delete.","type":"string"},"tabId":{"description":"The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteSuggestionRequest":{"description":"Deletes a suggestion. Returns a 403 forbidden error if the requesting user is not the author of the suggestion. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"suggestionId":{"description":"The ID of the suggestion.","type":"string"}}},"docs_v1_DeleteTabRequest":{"description":"Deletes a tab. If the tab has child tabs, they are deleted as well.","type":"object","properties":{"tabId":{"description":"The ID of the tab to delete.","type":"string"}}},"docs_v1_DeleteTableColumnRequest":{"description":"Deletes a column from a table.","type":"object","properties":{"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_DeleteTableRowRequest":{"description":"Deletes a row from a table.","type":"object","properties":{"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_Dimension":{"description":"A magnitude in a single direction in the specified units.","type":"object","properties":{"magnitude":{"description":"The magnitude.","format":"double","type":"number"},"unit":{"description":"The units for magnitude.","enum":["UNIT_UNSPECIFIED","PT"],"type":"string"}}},"docs_v1_Document":{"description":"A Google Docs document.","type":"object","properties":{"body":{"$ref":"#/components/schemas/docs_v1_Body"},"comments":{"description":"Output only. The comments associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/docs_v1_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the document. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"documentId":{"description":"Output only. The ID of the document.","type":"string"},"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"footers":{"description":"Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footer"}},"footnotes":{"description":"Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footnote"}},"headers":{"description":"Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Header"}},"inlineObjects":{"description":"Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_InlineObject"}},"lists":{"description":"Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_List"}},"namedRanges":{"description":"Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_NamedRanges"}},"namedStyles":{"$ref":"#/components/schemas/docs_v1_NamedStyles"},"positionedObjects":{"description":"Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObject"}},"revisionId":{"description":"Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.","type":"string"},"suggestedDocumentStyleChanges":{"description":"Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDocumentStyle"}},"suggestedNamedStylesChanges":{"description":"Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedNamedStyles"}},"suggestions":{"description":"Output only. The suggestions associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/docs_v1_SuggestionThread"}},"suggestionsViewMode":{"description":"Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.","enum":["DEFAULT_FOR_CURRENT_ACCESS","SUGGESTIONS_INLINE","PREVIEW_SUGGESTIONS_ACCEPTED","PREVIEW_WITHOUT_SUGGESTIONS"],"type":"string"},"tabs":{"description":"Output only. Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Tab"}},"title":{"description":"The title of the document.","type":"string"}}},"docs_v1_DocumentFormat":{"description":"Represents document-level format settings.","type":"object","properties":{"documentMode":{"description":"Whether the document has pages or is pageless.","enum":["DOCUMENT_MODE_UNSPECIFIED","PAGES","PAGELESS"],"type":"string"}}},"docs_v1_DocumentStyle":{"description":"The style of the document.","type":"object","properties":{"background":{"$ref":"#/components/schemas/docs_v1_Background"},"defaultFooterId":{"description":"The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"defaultHeaderId":{"description":"The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"documentFormat":{"$ref":"#/components/schemas/docs_v1_DocumentFormat"},"evenPageFooterId":{"description":"The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"evenPageHeaderId":{"description":"The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageFooterId":{"description":"The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageHeaderId":{"description":"The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"flipPageOrientation":{"description":"Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.","type":"boolean"},"marginBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginFooter":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginHeader":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"pageNumberStart":{"description":"The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.","format":"int32","type":"integer"},"pageSize":{"$ref":"#/components/schemas/docs_v1_Size"},"useCustomHeaderFooterMargins":{"description":"Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"boolean"},"useEvenPageHeaderFooter":{"description":"Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.","type":"boolean"},"useFirstPageHeaderFooter":{"description":"Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.","type":"boolean"}}},"docs_v1_DocumentStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundSuggestionState":{"$ref":"#/components/schemas/docs_v1_BackgroundSuggestionState"},"defaultFooterIdSuggested":{"description":"Indicates if there was a suggested change to default_footer_id.","type":"boolean"},"defaultHeaderIdSuggested":{"description":"Indicates if there was a suggested change to default_header_id.","type":"boolean"},"evenPageFooterIdSuggested":{"description":"Indicates if there was a suggested change to even_page_footer_id.","type":"boolean"},"evenPageHeaderIdSuggested":{"description":"Indicates if there was a suggested change to even_page_header_id.","type":"boolean"},"firstPageFooterIdSuggested":{"description":"Indicates if there was a suggested change to first_page_footer_id.","type":"boolean"},"firstPageHeaderIdSuggested":{"description":"Indicates if there was a suggested change to first_page_header_id.","type":"boolean"},"flipPageOrientationSuggested":{"description":"Optional. Indicates if there was a suggested change to flip_page_orientation.","type":"boolean"},"marginBottomSuggested":{"description":"Indicates if there was a suggested change to margin_bottom.","type":"boolean"},"marginFooterSuggested":{"description":"Indicates if there was a suggested change to margin_footer.","type":"boolean"},"marginHeaderSuggested":{"description":"Indicates if there was a suggested change to margin_header.","type":"boolean"},"marginLeftSuggested":{"description":"Indicates if there was a suggested change to margin_left.","type":"boolean"},"marginRightSuggested":{"description":"Indicates if there was a suggested change to margin_right.","type":"boolean"},"marginTopSuggested":{"description":"Indicates if there was a suggested change to margin_top.","type":"boolean"},"pageNumberStartSuggested":{"description":"Indicates if there was a suggested change to page_number_start.","type":"boolean"},"pageSizeSuggestionState":{"$ref":"#/components/schemas/docs_v1_SizeSuggestionState"},"useCustomHeaderFooterMarginsSuggested":{"description":"Indicates if there was a suggested change to use_custom_header_footer_margins.","type":"boolean"},"useEvenPageHeaderFooterSuggested":{"description":"Indicates if there was a suggested change to use_even_page_header_footer.","type":"boolean"},"useFirstPageHeaderFooterSuggested":{"description":"Indicates if there was a suggested change to use_first_page_header_footer.","type":"boolean"}}},"docs_v1_DocumentTab":{"description":"A tab with document contents.","type":"object","properties":{"body":{"$ref":"#/components/schemas/docs_v1_Body"},"commentAnchors":{"description":"The comment anchors in a document tab, keyed by anchor ID. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_CommentAnchor"}},"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"dropdownDefinitions":{"description":"The dropdown definitions in a document tab, keyed by dropdown definition ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinition"}},"footers":{"description":"The footers in the document tab, keyed by footer ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footer"}},"footnotes":{"description":"The footnotes in the document tab, keyed by footnote ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footnote"}},"headers":{"description":"The headers in the document tab, keyed by header ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Header"}},"inlineObjects":{"description":"The inline objects in the document tab, keyed by object ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_InlineObject"}},"lists":{"description":"The lists in the document tab, keyed by list ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_List"}},"namedRanges":{"description":"The named ranges in the document tab, keyed by name.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_NamedRanges"}},"namedStyles":{"$ref":"#/components/schemas/docs_v1_NamedStyles"},"positionedObjects":{"description":"The positioned objects in the document tab, keyed by object ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObject"}},"suggestedDocumentStyleChanges":{"description":"The suggested changes to the style of the document tab, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDocumentStyle"}},"suggestedNamedStylesChanges":{"description":"The suggested changes to the named styles of the document tab, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedNamedStyles"}}}},"docs_v1_Dropdown":{"description":"A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options.","type":"object","properties":{"dropdownId":{"description":"The ID of this dropdown.","type":"string"},"dropdownProperties":{"$ref":"#/components/schemas/docs_v1_DropdownProperties"},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedDropdownPropertiesChanges":{"description":"The suggested properties changes to this dropdown, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDropdownProperties"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this dropdown, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_DropdownDefinition":{"description":"A dropdown definition in the document.","type":"object","properties":{"dropdownDefinitionId":{"description":"The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated.","type":"string"},"dropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionProperties"},"suggestedDeletionId":{"description":"ID for suggestion that deletes this dropdown definition.","type":"string"},"suggestedDropdownDefinitionPropertiesChanges":{"description":"Suggested property changes to this definition, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDropdownDefinitionProperties"}},"suggestedInsertionId":{"description":"ID for suggestion that inserts this dropdown definition.","type":"string"}}},"docs_v1_DropdownDefinitionProperties":{"description":"Properties of a dropdown definition.","type":"object","properties":{"options":{"description":"The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_DropdownOption"}},"title":{"description":"The title of the dropdown definition.","type":"string"}}},"docs_v1_DropdownDefinitionPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"optionsSuggested":{"description":"Indicates if there was a suggested change to options.","type":"boolean"},"titleSuggested":{"description":"Indicates if there was a suggested change to title.","type":"boolean"}}},"docs_v1_DropdownOption":{"description":"An option in a Dropdown.","type":"object","properties":{"displayValue":{"description":"The display value of this dropdown option.","type":"string"},"optionId":{"description":"The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated.","type":"string"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_DropdownProperties":{"description":"Properties specific to a dropdown.","type":"object","properties":{"displayValue":{"description":"The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes.","type":"string"},"dropdownDefinitionId":{"description":"The ID of the DropdownDefinition that defines the options for this dropdown.","type":"string"},"selectedOptionId":{"description":"The ID of the selected option in this dropdown.","type":"string"}}},"docs_v1_DropdownPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"selectedOptionIdSuggested":{"description":"Indicates if there was a suggested change to selected_option_id.","type":"boolean"}}},"docs_v1_EmbeddedDrawingProperties":{"description":"The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.","type":"object"},"docs_v1_EmbeddedDrawingPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object"},"docs_v1_EmbeddedObject":{"description":"An embedded object in the document.","type":"object","properties":{"description":{"description":"The description of the embedded object. The `title` and `description` are both combined to display alt text.","type":"string"},"embeddedDrawingProperties":{"$ref":"#/components/schemas/docs_v1_EmbeddedDrawingProperties"},"embeddedObjectBorder":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectBorder"},"imageProperties":{"$ref":"#/components/schemas/docs_v1_ImageProperties"},"linkedContentReference":{"$ref":"#/components/schemas/docs_v1_LinkedContentReference"},"marginBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"size":{"$ref":"#/components/schemas/docs_v1_Size"},"title":{"description":"The title of the embedded object. The `title` and `description` are both combined to display alt text.","type":"string"}}},"docs_v1_EmbeddedObjectBorder":{"description":"A border around an EmbeddedObject.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH"],"type":"string"},"propertyState":{"description":"The property state of the border property.","enum":["RENDERED","NOT_RENDERED"],"type":"string"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_EmbeddedObjectBorderSuggestionState":{"description":"A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"colorSuggested":{"description":"Indicates if there was a suggested change to color.","type":"boolean"},"dashStyleSuggested":{"description":"Indicates if there was a suggested change to dash_style.","type":"boolean"},"propertyStateSuggested":{"description":"Indicates if there was a suggested change to property_state.","type":"boolean"},"widthSuggested":{"description":"Indicates if there was a suggested change to width.","type":"boolean"}}},"docs_v1_EmbeddedObjectSuggestionState":{"description":"A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"descriptionSuggested":{"description":"Indicates if there was a suggested change to description.","type":"boolean"},"embeddedDrawingPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedDrawingPropertiesSuggestionState"},"embeddedObjectBorderSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectBorderSuggestionState"},"imagePropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_ImagePropertiesSuggestionState"},"linkedContentReferenceSuggestionState":{"$ref":"#/components/schemas/docs_v1_LinkedContentReferenceSuggestionState"},"marginBottomSuggested":{"description":"Indicates if there was a suggested change to margin_bottom.","type":"boolean"},"marginLeftSuggested":{"description":"Indicates if there was a suggested change to margin_left.","type":"boolean"},"marginRightSuggested":{"description":"Indicates if there was a suggested change to margin_right.","type":"boolean"},"marginTopSuggested":{"description":"Indicates if there was a suggested change to margin_top.","type":"boolean"},"sizeSuggestionState":{"$ref":"#/components/schemas/docs_v1_SizeSuggestionState"},"titleSuggested":{"description":"Indicates if there was a suggested change to title.","type":"boolean"}}},"docs_v1_EndOfSegmentLocation":{"description":"Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment.","type":"object","properties":{"segmentId":{"description":"The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.","type":"string"},"tabId":{"description":"The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_Equation":{"description":"A ParagraphElement representing an equation.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}}}},"docs_v1_Footer":{"description":"A document footer.","type":"object","properties":{"content":{"description":"The contents of the footer. The indexes for a footer's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"footerId":{"description":"The ID of the footer.","type":"string"}}},"docs_v1_Footnote":{"description":"A document footnote.","type":"object","properties":{"content":{"description":"The contents of the footnote. The indexes for a footnote's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"footnoteId":{"description":"The ID of the footnote.","type":"string"}}},"docs_v1_FootnoteReference":{"description":"A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote.","type":"object","properties":{"footnoteId":{"description":"The ID of the footnote that contains the content of this footnote reference.","type":"string"},"footnoteNumber":{"description":"The rendered number of this footnote.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this FootnoteReference, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_Header":{"description":"A document header.","type":"object","properties":{"content":{"description":"The contents of the header. The indexes for a header's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"headerId":{"description":"The ID of the header.","type":"string"}}},"docs_v1_HeadingLink":{"description":"A reference to a heading in this document.","type":"object","properties":{"id":{"description":"The ID of a heading in this document.","type":"string"},"tabId":{"description":"The ID of the tab containing this heading.","type":"string"}}},"docs_v1_HorizontalRule":{"description":"A ParagraphElement representing a horizontal line.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this HorizontalRule, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_ImageProperties":{"description":"The properties of an image.","type":"object","properties":{"angle":{"description":"The clockwise rotation angle of the image, in radians.","format":"float","type":"number"},"brightness":{"description":"The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.","format":"float","type":"number"},"contentUri":{"description":"A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.","type":"string"},"contrast":{"description":"The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.","format":"float","type":"number"},"cropProperties":{"$ref":"#/components/schemas/docs_v1_CropProperties"},"sourceUri":{"description":"The source URI is the URI used to insert the image. The source URI can be empty.","type":"string"},"transparency":{"description":"The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.","format":"float","type":"number"}}},"docs_v1_ImagePropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"angleSuggested":{"description":"Indicates if there was a suggested change to angle.","type":"boolean"},"brightnessSuggested":{"description":"Indicates if there was a suggested change to brightness.","type":"boolean"},"contentUriSuggested":{"description":"Indicates if there was a suggested change to content_uri.","type":"boolean"},"contrastSuggested":{"description":"Indicates if there was a suggested change to contrast.","type":"boolean"},"cropPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_CropPropertiesSuggestionState"},"sourceUriSuggested":{"description":"Indicates if there was a suggested change to source_uri.","type":"boolean"},"transparencySuggested":{"description":"Indicates if there was a suggested change to transparency.","type":"boolean"}}},"docs_v1_InlineObject":{"description":"An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.","type":"object","properties":{"inlineObjectProperties":{"$ref":"#/components/schemas/docs_v1_InlineObjectProperties"},"objectId":{"description":"The ID of this inline object. Can be used to update an object’s properties.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInlineObjectPropertiesChanges":{"description":"The suggested changes to the inline object properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedInlineObjectProperties"}},"suggestedInsertionId":{"description":"The suggested insertion ID. If empty, then this is not a suggested insertion.","type":"string"}}},"docs_v1_InlineObjectElement":{"description":"A ParagraphElement that contains an InlineObject.","type":"object","properties":{"inlineObjectId":{"description":"The ID of the InlineObject this element contains.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this InlineObject, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_InlineObjectProperties":{"description":"Properties of an InlineObject.","type":"object","properties":{"embeddedObject":{"$ref":"#/components/schemas/docs_v1_EmbeddedObject"}}},"docs_v1_InlineObjectPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"embeddedObjectSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectSuggestionState"}}},"docs_v1_InsertCommentRequest":{"description":"Inserts a CommentThread into the document. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmailAddress":{"description":"Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units.","type":"string"},"content":{"description":"The text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_InsertCommentResponse":{"description":"Response message for inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentThread":{"$ref":"#/components/schemas/docs_v1_CommentThread"}}},"docs_v1_InsertDateRequest":{"description":"Inserts a date at the specified location.","type":"object","properties":{"dateElementProperties":{"$ref":"#/components/schemas/docs_v1_DateElementProperties"},"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_InsertDropdownRequest":{"description":"Inserts a Dropdown at the specified location.","type":"object","properties":{"dropdownDefinitionId":{"description":"Required. The DropdownDefinition ID.","type":"string"},"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"selectedOptionId":{"description":"Optional initial value for the dropdown. If this field is not specified, the new dropdown will default to selecting the first option defined in the dropdown definition. If this field is specified but does not reference a valid option in the dropdown definition, a 400 bad request error is returned.","type":"string"}}},"docs_v1_InsertDropdownResponse":{"description":"The result of inserting a Dropdown.","type":"object","properties":{"dropdown":{"$ref":"#/components/schemas/docs_v1_Dropdown"}}},"docs_v1_InsertInlineImageRequest":{"description":"Inserts an InlineObject containing an image at the given location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"objectSize":{"$ref":"#/components/schemas/docs_v1_Size"},"uri":{"description":"The image URI. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI must be publicly accessible and at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field.","type":"string"}}},"docs_v1_InsertInlineImageResponse":{"description":"The result of inserting an inline image.","type":"object","properties":{"objectId":{"description":"The ID of the created InlineObject.","type":"string"}}},"docs_v1_InsertInlineSheetsChartResponse":{"description":"The result of inserting an embedded Google Sheets chart.","type":"object","properties":{"objectId":{"description":"The object ID of the inserted chart.","type":"string"}}},"docs_v1_InsertPageBreakRequest":{"description":"Inserts a page break followed by a newline at the specified location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_InsertPersonRequest":{"description":"Inserts a person mention.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"personProperties":{"$ref":"#/components/schemas/docs_v1_PersonProperties"}}},"docs_v1_InsertRichLinkRequest":{"description":"Inserts a RichLink at the specified location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"richLinkProperties":{"$ref":"#/components/schemas/docs_v1_RichLinkProperties"}}},"docs_v1_InsertSectionBreakRequest":{"description":"Inserts a section break at the given location. A newline character will be inserted before the section break.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"sectionType":{"description":"The type of section to insert.","enum":["SECTION_TYPE_UNSPECIFIED","CONTINUOUS","NEXT_PAGE"],"type":"string"}}},"docs_v1_InsertTableColumnRequest":{"description":"Inserts an empty column into a table.","type":"object","properties":{"insertRight":{"description":"Whether to insert new column to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left.","type":"boolean"},"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_InsertTableRequest":{"description":"Inserts a table at the specified location. A newline character will be inserted before the inserted table.","type":"object","properties":{"columns":{"description":"The number of columns in the table.","format":"int32","type":"integer"},"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"rows":{"description":"The number of rows in the table.","format":"int32","type":"integer"}}},"docs_v1_InsertTableRowRequest":{"description":"Inserts an empty row into a table.","type":"object","properties":{"insertBelow":{"description":"Whether to insert new row below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell.","type":"boolean"},"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_InsertTextRequest":{"description":"Inserts text at the specified location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"text":{"description":"The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text.","type":"string"}}},"docs_v1_Link":{"description":"A reference to another portion of a document or an external URL resource.","type":"object","properties":{"bookmark":{"$ref":"#/components/schemas/docs_v1_BookmarkLink"},"bookmarkId":{"description":"The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.","type":"string"},"heading":{"$ref":"#/components/schemas/docs_v1_HeadingLink"},"headingId":{"description":"The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.","type":"string"},"tabId":{"description":"The ID of a tab in this document.","type":"string"},"url":{"description":"An external URL.","type":"string"}}},"docs_v1_LinkedContentReference":{"description":"A reference to the external linked source content.","type":"object","properties":{"sheetsChartReference":{"$ref":"#/components/schemas/docs_v1_SheetsChartReference"}}},"docs_v1_LinkedContentReferenceSuggestionState":{"description":"A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"sheetsChartReferenceSuggestionState":{"$ref":"#/components/schemas/docs_v1_SheetsChartReferenceSuggestionState"}}},"docs_v1_List":{"description":"A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.","type":"object","properties":{"listProperties":{"$ref":"#/components/schemas/docs_v1_ListProperties"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this list.","type":"array","items":{"type":"string"}},"suggestedInsertionId":{"description":"The suggested insertion ID. If empty, then this is not a suggested insertion.","type":"string"},"suggestedListPropertiesChanges":{"description":"The suggested changes to the list properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedListProperties"}}}},"docs_v1_ListProperties":{"description":"The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list.","type":"object","properties":{"nestingLevels":{"description":"Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NestingLevel"}}}},"docs_v1_ListPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"nestingLevelsSuggestionStates":{"description":"A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NestingLevelSuggestionState"}}}},"docs_v1_Location":{"description":"A particular location in the document.","type":"object","properties":{"index":{"description":"The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id.","format":"int32","type":"integer"},"segmentId":{"description":"The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.","type":"string"},"tabId":{"description":"The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_MergeTableCellsRequest":{"description":"Merges cells in a Table.","type":"object","properties":{"tableRange":{"$ref":"#/components/schemas/docs_v1_TableRange"}}},"docs_v1_NamedRange":{"description":"A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.","type":"object","properties":{"name":{"description":"The name of the named range.","type":"string"},"namedRangeId":{"description":"The ID of the named range.","type":"string"},"ranges":{"description":"The ranges that belong to this named range.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Range"}}}},"docs_v1_NamedRanges":{"description":"A collection of all the NamedRanges in the document that share a given name.","type":"object","properties":{"name":{"description":"The name that all the named ranges share.","type":"string"},"namedRanges":{"description":"The NamedRanges that share the same name.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NamedRange"}}}},"docs_v1_NamedStyle":{"description":"A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.","type":"object","properties":{"namedStyleType":{"description":"The type of this named style.","enum":["NAMED_STYLE_TYPE_UNSPECIFIED","NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6"],"type":"string"},"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_NamedStyleSuggestionState":{"description":"A suggestion state of a NamedStyle message.","type":"object","properties":{"namedStyleType":{"description":"The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle.","enum":["NAMED_STYLE_TYPE_UNSPECIFIED","NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6"],"type":"string"},"paragraphStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_ParagraphStyleSuggestionState"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_NamedStyles":{"description":"The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles.","type":"object","properties":{"styles":{"description":"The named styles. There's an entry for each of the possible named style types.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NamedStyle"}}}},"docs_v1_NamedStylesSuggestionState":{"description":"The suggestion state of a NamedStyles message.","type":"object","properties":{"stylesSuggestionStates":{"description":"A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NamedStyleSuggestionState"}}}},"docs_v1_NestingLevel":{"description":"Contains properties describing the look and feel of a list bullet at a given level of nesting.","type":"object","properties":{"bulletAlignment":{"description":"The alignment of the bullet within the space allotted for rendering the bullet.","enum":["BULLET_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"glyphFormat":{"description":"The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.","type":"string"},"glyphSymbol":{"description":"A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.","type":"string"},"glyphType":{"description":"The type of glyph used by bullets when paragraphs at this level of nesting is ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to the list item's order within the list.","enum":["GLYPH_TYPE_UNSPECIFIED","NONE","DECIMAL","ZERO_DECIMAL","UPPER_ALPHA","ALPHA","UPPER_ROMAN","ROMAN"],"type":"string"},"indentFirstLine":{"$ref":"#/components/schemas/docs_v1_Dimension"},"indentStart":{"$ref":"#/components/schemas/docs_v1_Dimension"},"startNumber":{"description":"The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.","format":"int32","type":"integer"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_NestingLevelSuggestionState":{"description":"A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"bulletAlignmentSuggested":{"description":"Indicates if there was a suggested change to bullet_alignment.","type":"boolean"},"glyphFormatSuggested":{"description":"Indicates if there was a suggested change to glyph_format.","type":"boolean"},"glyphSymbolSuggested":{"description":"Indicates if there was a suggested change to glyph_symbol.","type":"boolean"},"glyphTypeSuggested":{"description":"Indicates if there was a suggested change to glyph_type.","type":"boolean"},"indentFirstLineSuggested":{"description":"Indicates if there was a suggested change to indent_first_line.","type":"boolean"},"indentStartSuggested":{"description":"Indicates if there was a suggested change to indent_start.","type":"boolean"},"startNumberSuggested":{"description":"Indicates if there was a suggested change to start_number.","type":"boolean"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_ObjectReferences":{"description":"A collection of object IDs.","type":"object","properties":{"objectIds":{"description":"The object IDs.","type":"array","items":{"type":"string"}}}},"docs_v1_OptionalColor":{"description":"A color that can either be fully opaque or fully transparent.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_Color"}}},"docs_v1_PageBreak":{"description":"A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this PageBreak, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_Paragraph":{"description":"A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character.","type":"object","properties":{"bullet":{"$ref":"#/components/schemas/docs_v1_Bullet"},"elements":{"description":"The content of the paragraph, broken down into its component parts.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_ParagraphElement"}},"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"positionedObjectIds":{"description":"The IDs of the positioned objects tethered to this paragraph.","type":"array","items":{"type":"string"}},"suggestedBulletChanges":{"description":"The suggested changes to this paragraph's bullet.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedBullet"}},"suggestedParagraphStyleChanges":{"description":"The suggested paragraph style changes to this paragraph, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedParagraphStyle"}},"suggestedPositionedObjectIds":{"description":"The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_ObjectReferences"}}}},"docs_v1_ParagraphBorder":{"description":"A border around a paragraph.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH"],"type":"string"},"padding":{"$ref":"#/components/schemas/docs_v1_Dimension"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_ParagraphElement":{"description":"A ParagraphElement describes content within a Paragraph.","type":"object","properties":{"autoText":{"$ref":"#/components/schemas/docs_v1_AutoText"},"columnBreak":{"$ref":"#/components/schemas/docs_v1_ColumnBreak"},"dateElement":{"$ref":"#/components/schemas/docs_v1_DateElement"},"dropdown":{"$ref":"#/components/schemas/docs_v1_Dropdown"},"endIndex":{"description":"The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"equation":{"$ref":"#/components/schemas/docs_v1_Equation"},"footnoteReference":{"$ref":"#/components/schemas/docs_v1_FootnoteReference"},"horizontalRule":{"$ref":"#/components/schemas/docs_v1_HorizontalRule"},"inlineObjectElement":{"$ref":"#/components/schemas/docs_v1_InlineObjectElement"},"pageBreak":{"$ref":"#/components/schemas/docs_v1_PageBreak"},"person":{"$ref":"#/components/schemas/docs_v1_Person"},"richLink":{"$ref":"#/components/schemas/docs_v1_RichLink"},"startIndex":{"description":"The zero-based start index of this paragraph element, in UTF-16 code units.","format":"int32","type":"integer"},"textRun":{"$ref":"#/components/schemas/docs_v1_TextRun"}}},"docs_v1_ParagraphStyle":{"description":"Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor.","type":"object","properties":{"alignment":{"description":"The text alignment for this paragraph.","enum":["ALIGNMENT_UNSPECIFIED","START","CENTER","END","JUSTIFIED"],"type":"string"},"avoidWidowAndOrphan":{"description":"Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.","type":"boolean"},"borderBetween":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderBottom":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderLeft":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderRight":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderTop":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"direction":{"description":"The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.","enum":["CONTENT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"headingId":{"description":"The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.","type":"string"},"indentEnd":{"$ref":"#/components/schemas/docs_v1_Dimension"},"indentFirstLine":{"$ref":"#/components/schemas/docs_v1_Dimension"},"indentStart":{"$ref":"#/components/schemas/docs_v1_Dimension"},"keepLinesTogether":{"description":"Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.","type":"boolean"},"keepWithNext":{"description":"Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.","type":"boolean"},"lineSpacing":{"description":"The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.","format":"float","type":"number"},"namedStyleType":{"description":"The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.","enum":["NAMED_STYLE_TYPE_UNSPECIFIED","NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6"],"type":"string"},"pageBreakBefore":{"description":"Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.","type":"boolean"},"shading":{"$ref":"#/components/schemas/docs_v1_Shading"},"spaceAbove":{"$ref":"#/components/schemas/docs_v1_Dimension"},"spaceBelow":{"$ref":"#/components/schemas/docs_v1_Dimension"},"spacingMode":{"description":"The spacing mode for the paragraph.","enum":["SPACING_MODE_UNSPECIFIED","NEVER_COLLAPSE","COLLAPSE_LISTS"],"type":"string"},"tabStops":{"description":"A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TabStop"}}}},"docs_v1_ParagraphStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"alignmentSuggested":{"description":"Indicates if there was a suggested change to alignment.","type":"boolean"},"avoidWidowAndOrphanSuggested":{"description":"Indicates if there was a suggested change to avoid_widow_and_orphan.","type":"boolean"},"borderBetweenSuggested":{"description":"Indicates if there was a suggested change to border_between.","type":"boolean"},"borderBottomSuggested":{"description":"Indicates if there was a suggested change to border_bottom.","type":"boolean"},"borderLeftSuggested":{"description":"Indicates if there was a suggested change to border_left.","type":"boolean"},"borderRightSuggested":{"description":"Indicates if there was a suggested change to border_right.","type":"boolean"},"borderTopSuggested":{"description":"Indicates if there was a suggested change to border_top.","type":"boolean"},"directionSuggested":{"description":"Indicates if there was a suggested change to direction.","type":"boolean"},"headingIdSuggested":{"description":"Indicates if there was a suggested change to heading_id.","type":"boolean"},"indentEndSuggested":{"description":"Indicates if there was a suggested change to indent_end.","type":"boolean"},"indentFirstLineSuggested":{"description":"Indicates if there was a suggested change to indent_first_line.","type":"boolean"},"indentStartSuggested":{"description":"Indicates if there was a suggested change to indent_start.","type":"boolean"},"keepLinesTogetherSuggested":{"description":"Indicates if there was a suggested change to keep_lines_together.","type":"boolean"},"keepWithNextSuggested":{"description":"Indicates if there was a suggested change to keep_with_next.","type":"boolean"},"lineSpacingSuggested":{"description":"Indicates if there was a suggested change to line_spacing.","type":"boolean"},"namedStyleTypeSuggested":{"description":"Indicates if there was a suggested change to named_style_type.","type":"boolean"},"pageBreakBeforeSuggested":{"description":"Indicates if there was a suggested change to page_break_before.","type":"boolean"},"shadingSuggestionState":{"$ref":"#/components/schemas/docs_v1_ShadingSuggestionState"},"spaceAboveSuggested":{"description":"Indicates if there was a suggested change to space_above.","type":"boolean"},"spaceBelowSuggested":{"description":"Indicates if there was a suggested change to space_below.","type":"boolean"},"spacingModeSuggested":{"description":"Indicates if there was a suggested change to spacing_mode.","type":"boolean"}}},"docs_v1_Person":{"description":"A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address.","type":"object","properties":{"personId":{"description":"Output only. The unique ID of this link.","readOnly":true,"type":"string"},"personProperties":{"$ref":"#/components/schemas/docs_v1_PersonProperties"},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this Person, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_PersonProperties":{"description":"Properties specific to a linked Person.","type":"object","properties":{"email":{"description":"The email address linked to this Person. This field is always present.","type":"string"},"name":{"description":"The name of the person if it's displayed in the link text instead of the person's email address.","type":"string"}}},"docs_v1_PinTableHeaderRowsRequest":{"description":"Updates the number of pinned table header rows in a table.","type":"object","properties":{"pinnedHeaderRowsCount":{"description":"The number of table rows to pin, where 0 implies that all rows are unpinned.","format":"int32","type":"integer"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_PositionedObject":{"description":"An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.","type":"object","properties":{"objectId":{"description":"The ID of this positioned object.","type":"string"},"positionedObjectProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObjectProperties"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionId":{"description":"The suggested insertion ID. If empty, then this is not a suggested insertion.","type":"string"},"suggestedPositionedObjectPropertiesChanges":{"description":"The suggested changes to the positioned object properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedPositionedObjectProperties"}}}},"docs_v1_PositionedObjectPositioning":{"description":"The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to.","type":"object","properties":{"layout":{"description":"The layout of this positioned object.","enum":["POSITIONED_OBJECT_LAYOUT_UNSPECIFIED","WRAP_TEXT","BREAK_LEFT","BREAK_RIGHT","BREAK_LEFT_RIGHT","IN_FRONT_OF_TEXT","BEHIND_TEXT"],"type":"string"},"leftOffset":{"$ref":"#/components/schemas/docs_v1_Dimension"},"topOffset":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_PositionedObjectPositioningSuggestionState":{"description":"A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"layoutSuggested":{"description":"Indicates if there was a suggested change to layout.","type":"boolean"},"leftOffsetSuggested":{"description":"Indicates if there was a suggested change to left_offset.","type":"boolean"},"topOffsetSuggested":{"description":"Indicates if there was a suggested change to top_offset.","type":"boolean"}}},"docs_v1_PositionedObjectProperties":{"description":"Properties of a PositionedObject.","type":"object","properties":{"embeddedObject":{"$ref":"#/components/schemas/docs_v1_EmbeddedObject"},"positioning":{"$ref":"#/components/schemas/docs_v1_PositionedObjectPositioning"}}},"docs_v1_PositionedObjectPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"embeddedObjectSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectSuggestionState"},"positioningSuggestionState":{"$ref":"#/components/schemas/docs_v1_PositionedObjectPositioningSuggestionState"}}},"docs_v1_Post":{"description":"Represents a single post in a comment or suggestion thread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmail":{"description":"Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - The parent thread is a SuggestionThread. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assigneeEmail` exceeds 2048 UTF-8 code units.","type":"string"},"author":{"$ref":"#/components/schemas/docs_v1_PostAuthor"},"commentAction":{"description":"Optional. The action type for comment posts.","enum":["COMMENT_ACTION_TYPE_UNSPECIFIED","NO_COMMENT_ACTION_CHANGE","RESOLVE","REOPEN"],"type":"string"},"content":{"description":"The content of the post. Required to be non-empty if commentAction is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.","type":"string"},"contentHtml":{"description":"Output only. The content of the post as HTML.","type":"string"},"createTime":{"description":"Output only. The time the post was created.","format":"google-datetime","type":"string"},"deleted":{"description":"Output only. Whether the post is deleted. If `true`, content and author fields will be empty.","type":"boolean"},"fromCopiedDocument":{"description":"Output only. Whether the post is from a copied document. This field cannot be set directly by callers.","type":"boolean"},"fromDocumentComparison":{"description":"Output only. Whether the post is from a document comparison. This field cannot be set directly by callers.","type":"boolean"},"fromImportedDocument":{"description":"Output only. Whether the post is from an imported document. This field cannot be set directly by callers.","type":"boolean"},"postId":{"description":"Output only. The unique ID of the post.","type":"string"},"suggestionAction":{"description":"Output only. The action type for suggestion posts.","enum":["SUGGESTION_ACTION_TYPE_UNSPECIFIED","NO_SUGGESTION_ACTION_CHANGE","ACCEPT","REJECT"],"type":"string"},"updateTime":{"description":"Output only. The time the post was last updated.","format":"google-datetime","type":"string"}}},"docs_v1_PostAuthor":{"description":"Represents a user who authored a comment or suggestion post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anonymous":{"description":"Whether the user is anonymous.","type":"boolean"},"displayName":{"description":"The display name of the user. May be absent if the author is anonymous.","type":"string"},"me":{"description":"Whether the user is the authenticated user making the request.","type":"boolean"},"user":{"description":"The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported document.","type":"string"}}},"docs_v1_Range":{"description":"Specifies a contiguous range of text.","type":"object","properties":{"endIndex":{"description":"The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"},"segmentId":{"description":"The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.","type":"string"},"startIndex":{"description":"The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"},"tabId":{"description":"The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_RejectSuggestionRequest":{"description":"Rejects a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document and is not the author of the suggestion. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"suggestionId":{"description":"The ID of the suggestion.","type":"string"}}},"docs_v1_ReplaceAllTextRequest":{"description":"Replaces all instances of text matching a criteria with replace text.","type":"object","properties":{"containsText":{"$ref":"#/components/schemas/docs_v1_SubstringMatchCriteria"},"replaceText":{"description":"The text that will replace the matched text.","type":"string"},"tabsCriteria":{"$ref":"#/components/schemas/docs_v1_TabsCriteria"}}},"docs_v1_ReplaceAllTextResponse":{"description":"The result of replacing text.","type":"object","properties":{"occurrencesChanged":{"description":"The number of occurrences changed by replacing all text.","format":"int32","type":"integer"}}},"docs_v1_ReplaceImageRequest":{"description":"Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor.","type":"object","properties":{"imageObjectId":{"description":"The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.","type":"string"},"imageReplaceMethod":{"description":"The replacement method.","enum":["IMAGE_REPLACE_METHOD_UNSPECIFIED","CENTER_CROP"],"type":"string"},"tabId":{"description":"The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"},"uri":{"description":"The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.","type":"string"}}},"docs_v1_ReplaceNamedRangeContentRequest":{"description":"Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned.","type":"object","properties":{"namedRangeId":{"description":"The ID of the named range whose content will be replaced. If there is no named range with the given ID a 400 bad request error is returned.","type":"string"},"namedRangeName":{"description":"The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.","type":"string"},"tabsCriteria":{"$ref":"#/components/schemas/docs_v1_TabsCriteria"},"text":{"description":"Replaces the content of the specified named range(s) with the given text.","type":"string"}}},"docs_v1_Request":{"description":"A single update to apply to a document.","type":"object","properties":{"acceptSuggestion":{"$ref":"#/components/schemas/docs_v1_AcceptSuggestionRequest"},"addCommentReply":{"$ref":"#/components/schemas/docs_v1_AddCommentReplyRequest"},"addDocumentTab":{"$ref":"#/components/schemas/docs_v1_AddDocumentTabRequest"},"createDropdownDefinition":{"$ref":"#/components/schemas/docs_v1_CreateDropdownDefinitionRequest"},"createFooter":{"$ref":"#/components/schemas/docs_v1_CreateFooterRequest"},"createFootnote":{"$ref":"#/components/schemas/docs_v1_CreateFootnoteRequest"},"createHeader":{"$ref":"#/components/schemas/docs_v1_CreateHeaderRequest"},"createNamedRange":{"$ref":"#/components/schemas/docs_v1_CreateNamedRangeRequest"},"createParagraphBullets":{"$ref":"#/components/schemas/docs_v1_CreateParagraphBulletsRequest"},"deleteComment":{"$ref":"#/components/schemas/docs_v1_DeleteCommentRequest"},"deleteCommentReply":{"$ref":"#/components/schemas/docs_v1_DeleteCommentReplyRequest"},"deleteContentRange":{"$ref":"#/components/schemas/docs_v1_DeleteContentRangeRequest"},"deleteDropdownDefinition":{"$ref":"#/components/schemas/docs_v1_DeleteDropdownDefinitionRequest"},"deleteFooter":{"$ref":"#/components/schemas/docs_v1_DeleteFooterRequest"},"deleteHeader":{"$ref":"#/components/schemas/docs_v1_DeleteHeaderRequest"},"deleteNamedRange":{"$ref":"#/components/schemas/docs_v1_DeleteNamedRangeRequest"},"deleteParagraphBullets":{"$ref":"#/components/schemas/docs_v1_DeleteParagraphBulletsRequest"},"deletePositionedObject":{"$ref":"#/components/schemas/docs_v1_DeletePositionedObjectRequest"},"deleteSuggestion":{"$ref":"#/components/schemas/docs_v1_DeleteSuggestionRequest"},"deleteTab":{"$ref":"#/components/schemas/docs_v1_DeleteTabRequest"},"deleteTableColumn":{"$ref":"#/components/schemas/docs_v1_DeleteTableColumnRequest"},"deleteTableRow":{"$ref":"#/components/schemas/docs_v1_DeleteTableRowRequest"},"insertComment":{"$ref":"#/components/schemas/docs_v1_InsertCommentRequest"},"insertDate":{"$ref":"#/components/schemas/docs_v1_InsertDateRequest"},"insertDropdown":{"$ref":"#/components/schemas/docs_v1_InsertDropdownRequest"},"insertInlineImage":{"$ref":"#/components/schemas/docs_v1_InsertInlineImageRequest"},"insertPageBreak":{"$ref":"#/components/schemas/docs_v1_InsertPageBreakRequest"},"insertPerson":{"$ref":"#/components/schemas/docs_v1_InsertPersonRequest"},"insertRichLink":{"$ref":"#/components/schemas/docs_v1_InsertRichLinkRequest"},"insertSectionBreak":{"$ref":"#/components/schemas/docs_v1_InsertSectionBreakRequest"},"insertTable":{"$ref":"#/components/schemas/docs_v1_InsertTableRequest"},"insertTableColumn":{"$ref":"#/components/schemas/docs_v1_InsertTableColumnRequest"},"insertTableRow":{"$ref":"#/components/schemas/docs_v1_InsertTableRowRequest"},"insertText":{"$ref":"#/components/schemas/docs_v1_InsertTextRequest"},"mergeTableCells":{"$ref":"#/components/schemas/docs_v1_MergeTableCellsRequest"},"pinTableHeaderRows":{"$ref":"#/components/schemas/docs_v1_PinTableHeaderRowsRequest"},"rejectSuggestion":{"$ref":"#/components/schemas/docs_v1_RejectSuggestionRequest"},"replaceAllText":{"$ref":"#/components/schemas/docs_v1_ReplaceAllTextRequest"},"replaceImage":{"$ref":"#/components/schemas/docs_v1_ReplaceImageRequest"},"replaceNamedRangeContent":{"$ref":"#/components/schemas/docs_v1_ReplaceNamedRangeContentRequest"},"unmergeTableCells":{"$ref":"#/components/schemas/docs_v1_UnmergeTableCellsRequest"},"updateCommentPost":{"$ref":"#/components/schemas/docs_v1_UpdateCommentPostRequest"},"updateDocumentStyle":{"$ref":"#/components/schemas/docs_v1_UpdateDocumentStyleRequest"},"updateDocumentTabProperties":{"$ref":"#/components/schemas/docs_v1_UpdateDocumentTabPropertiesRequest"},"updateDropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_UpdateDropdownDefinitionPropertiesRequest"},"updateDropdownProperties":{"$ref":"#/components/schemas/docs_v1_UpdateDropdownPropertiesRequest"},"updateNamedStyle":{"$ref":"#/components/schemas/docs_v1_UpdateNamedStyleRequest"},"updateParagraphStyle":{"$ref":"#/components/schemas/docs_v1_UpdateParagraphStyleRequest"},"updateSectionStyle":{"$ref":"#/components/schemas/docs_v1_UpdateSectionStyleRequest"},"updateTableCellStyle":{"$ref":"#/components/schemas/docs_v1_UpdateTableCellStyleRequest"},"updateTableColumnProperties":{"$ref":"#/components/schemas/docs_v1_UpdateTableColumnPropertiesRequest"},"updateTableRowStyle":{"$ref":"#/components/schemas/docs_v1_UpdateTableRowStyleRequest"},"updateTextStyle":{"$ref":"#/components/schemas/docs_v1_UpdateTextStyleRequest"}}},"docs_v1_Response":{"description":"A single response from an update.","type":"object","properties":{"addCommentReply":{"$ref":"#/components/schemas/docs_v1_AddCommentReplyResponse"},"addDocumentTab":{"$ref":"#/components/schemas/docs_v1_AddDocumentTabResponse"},"createDropdownDefinition":{"$ref":"#/components/schemas/docs_v1_CreateDropdownDefinitionResponse"},"createFooter":{"$ref":"#/components/schemas/docs_v1_CreateFooterResponse"},"createFootnote":{"$ref":"#/components/schemas/docs_v1_CreateFootnoteResponse"},"createHeader":{"$ref":"#/components/schemas/docs_v1_CreateHeaderResponse"},"createNamedRange":{"$ref":"#/components/schemas/docs_v1_CreateNamedRangeResponse"},"insertComment":{"$ref":"#/components/schemas/docs_v1_InsertCommentResponse"},"insertDropdown":{"$ref":"#/components/schemas/docs_v1_InsertDropdownResponse"},"insertInlineImage":{"$ref":"#/components/schemas/docs_v1_InsertInlineImageResponse"},"insertInlineSheetsChart":{"$ref":"#/components/schemas/docs_v1_InsertInlineSheetsChartResponse"},"replaceAllText":{"$ref":"#/components/schemas/docs_v1_ReplaceAllTextResponse"}}},"docs_v1_RgbColor":{"description":"An RGB color.","type":"object","properties":{"blue":{"description":"The blue component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"green":{"description":"The green component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"red":{"description":"The red component of the color, from 0.0 to 1.0.","format":"float","type":"number"}}},"docs_v1_RichLink":{"description":"A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event).","type":"object","properties":{"richLinkId":{"description":"Output only. The ID of this link.","readOnly":true,"type":"string"},"richLinkProperties":{"$ref":"#/components/schemas/docs_v1_RichLinkProperties"},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this RichLink, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_RichLinkProperties":{"description":"Properties specific to a RichLink.","type":"object","properties":{"mimeType":{"description":"The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).","type":"string"},"title":{"description":"The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.","type":"string"},"uri":{"description":"The URI to the RichLink. This is always present.","type":"string"}}},"docs_v1_SectionBreak":{"description":"A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.","type":"object","properties":{"sectionStyle":{"$ref":"#/components/schemas/docs_v1_SectionStyle"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}}}},"docs_v1_SectionColumnProperties":{"description":"Properties that apply to a section's column.","type":"object","properties":{"paddingEnd":{"$ref":"#/components/schemas/docs_v1_Dimension"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_SectionStyle":{"description":"The styling that applies to a section.","type":"object","properties":{"columnProperties":{"description":"The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_SectionColumnProperties"}},"columnSeparatorStyle":{"description":"The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","enum":["COLUMN_SEPARATOR_STYLE_UNSPECIFIED","NONE","BETWEEN_EACH_COLUMN"],"type":"string"},"contentDirection":{"description":"The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","enum":["CONTENT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"defaultFooterId":{"description":"The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"defaultHeaderId":{"description":"The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"evenPageFooterId":{"description":"The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"evenPageHeaderId":{"description":"The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageFooterId":{"description":"The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageHeaderId":{"description":"The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"flipPageOrientation":{"description":"Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","type":"boolean"},"marginBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginFooter":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginHeader":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"pageNumberStart":{"description":"The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","format":"int32","type":"integer"},"sectionType":{"description":"Output only. The type of section.","enum":["SECTION_TYPE_UNSPECIFIED","CONTINUOUS","NEXT_PAGE"],"type":"string"},"useFirstPageHeaderFooter":{"description":"Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","type":"boolean"}}},"docs_v1_Shading":{"description":"The shading of a paragraph.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"}}},"docs_v1_ShadingSuggestionState":{"description":"A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates if there was a suggested change to the Shading.","type":"boolean"}}},"docs_v1_SheetsChartReference":{"description":"A reference to a linked chart embedded from Google Sheets.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet that's embedded.","format":"int32","type":"integer"},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the source chart.","type":"string"}}},"docs_v1_SheetsChartReferenceSuggestionState":{"description":"A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"chartIdSuggested":{"description":"Indicates if there was a suggested change to chart_id.","type":"boolean"},"spreadsheetIdSuggested":{"description":"Indicates if there was a suggested change to spreadsheet_id.","type":"boolean"}}},"docs_v1_Size":{"description":"A width and height.","type":"object","properties":{"height":{"$ref":"#/components/schemas/docs_v1_Dimension"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_SizeSuggestionState":{"description":"A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value.","type":"object","properties":{"heightSuggested":{"description":"Indicates if there was a suggested change to height.","type":"boolean"},"widthSuggested":{"description":"Indicates if there was a suggested change to width.","type":"boolean"}}},"docs_v1_StructuralElement":{"description":"A StructuralElement describes content that provides structure to the document.","type":"object","properties":{"endIndex":{"description":"The zero-based end index of this structural element, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"paragraph":{"$ref":"#/components/schemas/docs_v1_Paragraph"},"sectionBreak":{"$ref":"#/components/schemas/docs_v1_SectionBreak"},"startIndex":{"description":"The zero-based start index of this structural element, in UTF-16 code units.","format":"int32","type":"integer"},"table":{"$ref":"#/components/schemas/docs_v1_Table"},"tableOfContents":{"$ref":"#/components/schemas/docs_v1_TableOfContents"}}},"docs_v1_SubstringMatchCriteria":{"description":"A criteria that matches a specific string of text in the document.","type":"object","properties":{"matchCase":{"description":"Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive.","type":"boolean"},"searchByRegex":{"description":"Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching.","type":"boolean"},"text":{"description":"The text to search for in the document.","type":"string"}}},"docs_v1_SuggestedBullet":{"description":"A suggested change to a Bullet.","type":"object","properties":{"bullet":{"$ref":"#/components/schemas/docs_v1_Bullet"},"bulletSuggestionState":{"$ref":"#/components/schemas/docs_v1_BulletSuggestionState"}}},"docs_v1_SuggestedDateElementProperties":{"description":"A suggested change to a DateElementProperties.","type":"object","properties":{"dateElementProperties":{"$ref":"#/components/schemas/docs_v1_DateElementProperties"},"dateElementPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_DateElementPropertiesSuggestionState"}}},"docs_v1_SuggestedDocumentStyle":{"description":"A suggested change to the DocumentStyle.","type":"object","properties":{"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"documentStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_DocumentStyleSuggestionState"}}},"docs_v1_SuggestedDropdownDefinitionProperties":{"description":"A suggested change to dropdown definition properties.","type":"object","properties":{"dropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionProperties"},"dropdownDefinitionPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionPropertiesSuggestionState"}}},"docs_v1_SuggestedDropdownProperties":{"description":"A suggested change to dropdown properties.","type":"object","properties":{"dropdownProperties":{"$ref":"#/components/schemas/docs_v1_DropdownProperties"},"dropdownPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_DropdownPropertiesSuggestionState"}}},"docs_v1_SuggestedInlineObjectProperties":{"description":"A suggested change to InlineObjectProperties.","type":"object","properties":{"inlineObjectProperties":{"$ref":"#/components/schemas/docs_v1_InlineObjectProperties"},"inlineObjectPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_InlineObjectPropertiesSuggestionState"}}},"docs_v1_SuggestedListProperties":{"description":"A suggested change to ListProperties.","type":"object","properties":{"listProperties":{"$ref":"#/components/schemas/docs_v1_ListProperties"},"listPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_ListPropertiesSuggestionState"}}},"docs_v1_SuggestedNamedStyles":{"description":"A suggested change to the NamedStyles.","type":"object","properties":{"namedStyles":{"$ref":"#/components/schemas/docs_v1_NamedStyles"},"namedStylesSuggestionState":{"$ref":"#/components/schemas/docs_v1_NamedStylesSuggestionState"}}},"docs_v1_SuggestedParagraphStyle":{"description":"A suggested change to a ParagraphStyle.","type":"object","properties":{"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"paragraphStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_ParagraphStyleSuggestionState"}}},"docs_v1_SuggestedPositionedObjectProperties":{"description":"A suggested change to PositionedObjectProperties.","type":"object","properties":{"positionedObjectProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObjectProperties"},"positionedObjectPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_PositionedObjectPropertiesSuggestionState"}}},"docs_v1_SuggestedTableCellStyle":{"description":"A suggested change to a TableCellStyle.","type":"object","properties":{"tableCellStyle":{"$ref":"#/components/schemas/docs_v1_TableCellStyle"},"tableCellStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TableCellStyleSuggestionState"}}},"docs_v1_SuggestedTableRowStyle":{"description":"A suggested change to a TableRowStyle.","type":"object","properties":{"tableRowStyle":{"$ref":"#/components/schemas/docs_v1_TableRowStyle"},"tableRowStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TableRowStyleSuggestionState"}}},"docs_v1_SuggestedTextStyle":{"description":"A suggested change to a TextStyle.","type":"object","properties":{"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_SuggestionResponse":{"description":"The suggestions which were affected by a given update. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"acceptedSuggestionIds":{"description":"The IDs of suggestions which were accepted during the update.","type":"array","items":{"type":"string"}},"createdSuggestionIds":{"description":"The IDs of suggestions which were created during the update.","type":"array","items":{"type":"string"}},"deletedSuggestionIds":{"description":"The IDs of suggestions which were deleted during the update.","type":"array","items":{"type":"string"}},"rejectedSuggestionIds":{"description":"The IDs of suggestions which were rejected during the update.","type":"array","items":{"type":"string"}},"updatedSummarySuggestionIds":{"description":"The IDs of suggestions whose summaries were updated during the update.","type":"array","items":{"type":"string"}}}},"docs_v1_SuggestionThread":{"description":"Represents a single suggestion thread. Suggestion threads are created as a byproduct of saving changes to the document while in suggestion mode, and cannot be created directly. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"headPost":{"$ref":"#/components/schemas/docs_v1_Post"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Post"}},"status":{"description":"Whether the thread is open, accepted, or rejected.","enum":["STATUS_UNSPECIFIED","OPEN","ACCEPTED","REJECTED"],"type":"string"},"suggestionId":{"description":"The unique ID of the suggestion.","type":"string"},"summaryHtml":{"description":"Summary of the suggested differences in the document, in HTML. May be empty.","type":"string"},"summaryText":{"description":"Summary of the suggested differences in the document, in plain text. May be empty.","type":"string"}}},"docs_v1_Tab":{"description":"A tab in a document.","type":"object","properties":{"childTabs":{"description":"The child tabs nested within this tab.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Tab"}},"documentTab":{"$ref":"#/components/schemas/docs_v1_DocumentTab"},"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_TabProperties":{"description":"Properties of a tab.","type":"object","properties":{"iconEmoji":{"description":"Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value is unset or empty, the tab will display the default tab icon.","type":"string"},"index":{"description":"The zero-based index of the tab within the parent.","format":"int32","type":"integer"},"nestingLevel":{"description":"Output only. The depth of the tab within the document. Root-level tabs start at 0.","format":"int32","type":"integer"},"parentTabId":{"description":"Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.","type":"string"},"tabId":{"description":"The immutable ID of the tab.","type":"string"},"title":{"description":"The user-visible name of the tab.","type":"string"}}},"docs_v1_TabStop":{"description":"A tab stop within a paragraph.","type":"object","properties":{"alignment":{"description":"The alignment of this tab stop. If unset, the value defaults to START.","enum":["TAB_STOP_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"offset":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_Table":{"description":"A StructuralElement representing a table.","type":"object","properties":{"columns":{"description":"Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.","format":"int32","type":"integer"},"rows":{"description":"Number of rows in the table.","format":"int32","type":"integer"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"tableRows":{"description":"The contents and style of each row.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TableRow"}},"tableStyle":{"$ref":"#/components/schemas/docs_v1_TableStyle"}}},"docs_v1_TableCell":{"description":"The contents and style of a cell in a Table.","type":"object","properties":{"content":{"description":"The content of the cell.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"endIndex":{"description":"The zero-based end index of this cell, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"startIndex":{"description":"The zero-based start index of this cell, in UTF-16 code units.","format":"int32","type":"integer"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTableCellStyleChanges":{"description":"The suggested changes to the table cell style, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTableCellStyle"}},"tableCellStyle":{"$ref":"#/components/schemas/docs_v1_TableCellStyle"}}},"docs_v1_TableCellBorder":{"description":"A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH"],"type":"string"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_TableCellLocation":{"description":"Location of a single cell within a table.","type":"object","properties":{"columnIndex":{"description":"The zero-based column index. For example, the second column in the table has a column index of 1.","format":"int32","type":"integer"},"rowIndex":{"description":"The zero-based row index. For example, the second row in the table has a row index of 1.","format":"int32","type":"integer"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_TableCellStyle":{"description":"The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"borderBottom":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"borderLeft":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"borderRight":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"borderTop":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"columnSpan":{"description":"The column span of the cell. This property is read-only.","format":"int32","type":"integer"},"contentAlignment":{"description":"The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.","enum":["CONTENT_ALIGNMENT_UNSPECIFIED","CONTENT_ALIGNMENT_UNSUPPORTED","TOP","MIDDLE","BOTTOM"],"type":"string"},"paddingBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"paddingLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"paddingRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"paddingTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"rowSpan":{"description":"The row span of the cell. This property is read-only.","format":"int32","type":"integer"}}},"docs_v1_TableCellStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates if there was a suggested change to background_color.","type":"boolean"},"borderBottomSuggested":{"description":"Indicates if there was a suggested change to border_bottom.","type":"boolean"},"borderLeftSuggested":{"description":"Indicates if there was a suggested change to border_left.","type":"boolean"},"borderRightSuggested":{"description":"Indicates if there was a suggested change to border_right.","type":"boolean"},"borderTopSuggested":{"description":"Indicates if there was a suggested change to border_top.","type":"boolean"},"columnSpanSuggested":{"description":"Indicates if there was a suggested change to column_span.","type":"boolean"},"contentAlignmentSuggested":{"description":"Indicates if there was a suggested change to content_alignment.","type":"boolean"},"paddingBottomSuggested":{"description":"Indicates if there was a suggested change to padding_bottom.","type":"boolean"},"paddingLeftSuggested":{"description":"Indicates if there was a suggested change to padding_left.","type":"boolean"},"paddingRightSuggested":{"description":"Indicates if there was a suggested change to padding_right.","type":"boolean"},"paddingTopSuggested":{"description":"Indicates if there was a suggested change to padding_top.","type":"boolean"},"rowSpanSuggested":{"description":"Indicates if there was a suggested change to row_span.","type":"boolean"}}},"docs_v1_TableColumnProperties":{"description":"The properties of a column in a table.","type":"object","properties":{"width":{"$ref":"#/components/schemas/docs_v1_Dimension"},"widthType":{"description":"The width type of the column.","enum":["WIDTH_TYPE_UNSPECIFIED","EVENLY_DISTRIBUTED","FIXED_WIDTH"],"type":"string"}}},"docs_v1_TableOfContents":{"description":"A StructuralElement representing a table of contents.","type":"object","properties":{"content":{"description":"The content of the table of contents.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}}}},"docs_v1_TableRange":{"description":"A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with table cell location = (table_start_location, row = 0, column = 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]","type":"object","properties":{"columnSpan":{"description":"The column span of the table range.","format":"int32","type":"integer"},"rowSpan":{"description":"The row span of the table range.","format":"int32","type":"integer"},"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_TableRow":{"description":"The contents and style of a row in a Table.","type":"object","properties":{"endIndex":{"description":"The zero-based end index of this row, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"startIndex":{"description":"The zero-based start index of this row, in UTF-16 code units.","format":"int32","type":"integer"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTableRowStyleChanges":{"description":"The suggested style changes to this row, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTableRowStyle"}},"tableCells":{"description":"The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TableCell"}},"tableRowStyle":{"$ref":"#/components/schemas/docs_v1_TableRowStyle"}}},"docs_v1_TableRowStyle":{"description":"Styles that apply to a table row.","type":"object","properties":{"minRowHeight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"preventOverflow":{"description":"Whether the row cannot overflow across page or column boundaries.","type":"boolean"},"tableHeader":{"description":"Whether the row is a table header.","type":"boolean"}}},"docs_v1_TableRowStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"minRowHeightSuggested":{"description":"Indicates if there was a suggested change to min_row_height.","type":"boolean"}}},"docs_v1_TableStyle":{"description":"Styles that apply to a table.","type":"object","properties":{"tableColumnProperties":{"description":"The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TableColumnProperties"}}}},"docs_v1_TabsCriteria":{"description":"A criteria that specifies in which tabs a request executes.","type":"object","properties":{"tabIds":{"description":"The list of tab IDs in which the request executes.","type":"array","items":{"type":"string"}}}},"docs_v1_TextRun":{"description":"A ParagraphElement that represents a run of text that all has the same styling.","type":"object","properties":{"content":{"description":"The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this run, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_TextStyle":{"description":"Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"baselineOffset":{"description":"The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.","enum":["BASELINE_OFFSET_UNSPECIFIED","NONE","SUPERSCRIPT","SUBSCRIPT"],"type":"string"},"bold":{"description":"Whether or not the text is rendered as bold.","type":"boolean"},"fontSize":{"$ref":"#/components/schemas/docs_v1_Dimension"},"foregroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"italic":{"description":"Whether or not the text is italicized.","type":"boolean"},"link":{"$ref":"#/components/schemas/docs_v1_Link"},"smallCaps":{"description":"Whether or not the text is in small capital letters.","type":"boolean"},"strikethrough":{"description":"Whether or not the text is struck through.","type":"boolean"},"underline":{"description":"Whether or not the text is underlined.","type":"boolean"},"weightedFontFamily":{"$ref":"#/components/schemas/docs_v1_WeightedFontFamily"}}},"docs_v1_TextStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates if there was a suggested change to background_color.","type":"boolean"},"baselineOffsetSuggested":{"description":"Indicates if there was a suggested change to baseline_offset.","type":"boolean"},"boldSuggested":{"description":"Indicates if there was a suggested change to bold.","type":"boolean"},"fontSizeSuggested":{"description":"Indicates if there was a suggested change to font_size.","type":"boolean"},"foregroundColorSuggested":{"description":"Indicates if there was a suggested change to foreground_color.","type":"boolean"},"italicSuggested":{"description":"Indicates if there was a suggested change to italic.","type":"boolean"},"linkSuggested":{"description":"Indicates if there was a suggested change to link.","type":"boolean"},"smallCapsSuggested":{"description":"Indicates if there was a suggested change to small_caps.","type":"boolean"},"strikethroughSuggested":{"description":"Indicates if there was a suggested change to strikethrough.","type":"boolean"},"underlineSuggested":{"description":"Indicates if there was a suggested change to underline.","type":"boolean"},"weightedFontFamilySuggested":{"description":"Indicates if there was a suggested change to weighted_font_family.","type":"boolean"}}},"docs_v1_UnmergeTableCellsRequest":{"description":"Unmerges cells in a Table.","type":"object","properties":{"tableRange":{"$ref":"#/components/schemas/docs_v1_TableRange"}}},"docs_v1_UpdateCommentPostRequest":{"description":"Updates a Post in a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The post is the headPost of a SuggestionThread. - The requesting user is not the author of the post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"content":{"description":"The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"postId":{"description":"The ID of the post being updated.","type":"string"},"suggestionId":{"description":"The ID of the SuggestionThread which the post belongs to.","type":"string"}}},"docs_v1_UpdateDocumentStyleRequest":{"description":"Updates the DocumentStyle.","type":"object","properties":{"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `\"background\"`.","format":"google-fieldmask","type":"string"},"tabId":{"description":"The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_UpdateDocumentTabPropertiesRequest":{"description":"Update the properties of a document tab.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tab_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_UpdateDropdownDefinitionPropertiesRequest":{"description":"Updates the properties of a DropdownDefinition.","type":"object","properties":{"dropdownDefinitionId":{"description":"The ID of the DropdownDefinition to update.","type":"string"},"dropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionProperties"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`.","format":"google-fieldmask","type":"string"},"selectedOptionIdReplacements":{"description":"A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{\"A\": \"B\"}`.","type":"object","additionalProperties":{"type":"string"}},"tabId":{"description":"The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_UpdateDropdownPropertiesRequest":{"description":"Updates the properties of a Dropdown.","type":"object","properties":{"dropdownId":{"description":"Required. The Dropdown ID.","type":"string"},"dropdownProperties":{"$ref":"#/components/schemas/docs_v1_DropdownProperties"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dropdown_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"tabId":{"description":"The ID of the tab that contains the dropdown to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_UpdateNamedStyleRequest":{"description":"Updates a named style.","type":"object","properties":{"fields":{"description":"The NamedStyle fields that should be updated. At least `named_style_type` must be specified. The root `named_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `\"text_style\"` and `\"text_style.bold\"`. To update the paragraph style's alignment property, set `fields` to include `\"paragraph_style\"` and `\"paragraph_style.alignment\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `\"text_style\"` or `\"paragraph_style\"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields.","format":"google-fieldmask","type":"string"},"namedStyle":{"$ref":"#/components/schemas/docs_v1_NamedStyle"},"tabId":{"description":"The document tab to update. By default, the update is applied to the first tab.","type":"string"}}},"docs_v1_UpdateParagraphStyleRequest":{"description":"Update the styling of all paragraphs that overlap with the given range.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set `fields` to `\"alignment\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_UpdateSectionStyleRequest":{"description":"Updates the SectionStyle.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `section_style` is implied and must not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the left margin, set `fields` to `\"margin_left\"`.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"},"sectionStyle":{"$ref":"#/components/schemas/docs_v1_SectionStyle"}}},"docs_v1_UpdateTableCellStyleRequest":{"description":"Updates the style of a range of table cells.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableCellStyle` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the table cell background color, set `fields` to `\"backgroundColor\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"tableCellStyle":{"$ref":"#/components/schemas/docs_v1_TableCellStyle"},"tableRange":{"$ref":"#/components/schemas/docs_v1_TableRange"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_UpdateTableColumnPropertiesRequest":{"description":"Updates the TableColumnProperties of columns in a table.","type":"object","properties":{"columnIndices":{"description":"The list of zero-based column indices whose property should be updated. If no indices are specified, all columns will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `\"width\"`.","format":"google-fieldmask","type":"string"},"tableColumnProperties":{"$ref":"#/components/schemas/docs_v1_TableColumnProperties"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_UpdateTableRowStyleRequest":{"description":"Updates the TableRowStyle of rows in a table.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableRowStyle` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `\"min_row_height\"`.","format":"google-fieldmask","type":"string"},"rowIndices":{"description":"The list of zero-based row indices whose style should be updated. If no indices are specified, all rows will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"tableRowStyle":{"$ref":"#/components/schemas/docs_v1_TableRowStyle"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_UpdateTextStyleRequest":{"description":"Update the styling of text.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `text_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `\"bold\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_WeightedFontFamily":{"description":"Represents a font family and weight of text.","type":"object","properties":{"fontFamily":{"description":"The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.","type":"string"},"weight":{"description":"The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` (\"normal\"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.","format":"int32","type":"integer"}}},"docs_v1_WriteControl":{"description":"Provides control over how write requests are executed.","type":"object","properties":{"requiredRevisionId":{"description":"The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.","type":"string"},"targetRevisionId":{"description":"The optional target revision ID of the document the write request is applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request are applied against the collaborator changes. This results in a new revision of the document that incorporates both the collaborator changes and the changes in the request, with the Docs server resolving conflicting changes. When using target revision ID, the API client can be thought of as another collaborator of the document. The target revision ID can only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 bad request error. The request should be tried again after retrieving the latest version of the document. Usually a revision ID remains valid for use as a target revision for several minutes after it's read, but for frequently edited documents this window might be shorter.","type":"string"},"writeMode":{"description":"How the request updates should be applied to the document. If unspecified, the request updates will be applied as normal edits. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["WRITE_MODE_UNSPECIFIED","EDIT","SUGGEST"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/documents":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/documents"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/docs/v1/rest","service":"docs","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Docs API","version":"v1","description":"Reads and writes Google Docs documents."},"servers":[{"url":"https://docs.googleapis.com/"}],"paths":{"/v1/documents":{"post":{"operationId":"docs.documents.create","x-executor-toolPath":"docs.documents.create","tags":["Google Docs API"],"description":"Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_Document"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_Document"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/documents"]}],"x-google-scopes":["https://www.googleapis.com/auth/documents"]}},"/v1/documents/{documentId}":{"get":{"operationId":"docs.documents.get","x-executor-toolPath":"docs.documents.get","tags":["Google Docs API"],"description":"Gets the latest version of the specified document.","parameters":[{"name":"documentId","in":"path","required":true,"description":"The ID of the document to retrieve.","schema":{"description":"The ID of the document to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to `true` or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. [Developer Preview](https://developers.google.com/workspace/preview).","schema":{"description":"The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to `true` or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeTabsContent","in":"query","required":false,"description":"Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content populates in the `Document.tabs` field instead of the text content fields in `Document`. - When `false`: The content of the document's first tab populates the content fields in `Document` excluding `Document.tabs`. If a document has only one tab, then that tab is used to populate the document content. `Document.tabs` will be empty. If you use a field mask that references the `Document.tabs` field (or any subfield), the API implicitly treats the request as if you set `include_tabs_content` to `true`.","schema":{"description":"Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content populates in the `Document.tabs` field instead of the text content fields in `Document`. - When `false`: The content of the document's first tab populates the content fields in `Document` excluding `Document.tabs`. If a document has only one tab, then that tab is used to populate the document content. `Document.tabs` will be empty. If you use a field mask that references the `Document.tabs` field (or any subfield), the API implicitly treats the request as if you set `include_tabs_content` to `true`.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"suggestionsViewMode","in":"query","required":false,"description":"The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.","schema":{"description":"The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.","enum":["DEFAULT_FOR_CURRENT_ACCESS","SUGGESTIONS_INLINE","PREVIEW_SUGGESTIONS_ACCEPTED","PREVIEW_WITHOUT_SUGGESTIONS"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_Document"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/documents.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/documents"]}],"x-google-scopes":["https://www.googleapis.com/auth/documents.readonly","https://www.googleapis.com/auth/documents"]}},"/v1/documents/{documentId}:batchUpdate":{"post":{"operationId":"docs.documents.batchUpdate","x-executor-toolPath":"docs.documents.batchUpdate","tags":["Google Docs API"],"description":"Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.","parameters":[{"name":"documentId","in":"path","required":true,"description":"The ID of the document to update.","schema":{"description":"The ID of the document to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_BatchUpdateDocumentRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docs_v1_BatchUpdateDocumentResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/documents"]}],"x-google-scopes":["https://www.googleapis.com/auth/documents"]}}},"components":{"schemas":{"docs_v1_AcceptSuggestionRequest":{"description":"Accepts a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"suggestionId":{"description":"The ID of the suggestion.","type":"string"}}},"docs_v1_AddCommentReplyRequest":{"description":"Inserts a reply Post into a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread to add the reply to.","type":"string"},"post":{"$ref":"#/components/schemas/docs_v1_Post"},"suggestionId":{"description":"The ID of the SuggestionThread to add the reply to.","type":"string"}}},"docs_v1_AddCommentReplyResponse":{"description":"Response message for adding a reply. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"post":{"$ref":"#/components/schemas/docs_v1_Post"}}},"docs_v1_AddDocumentTabRequest":{"description":"Adds a document tab. When a tab is added at a given index, all subsequent tabs' indexes are incremented.","type":"object","properties":{"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_AddDocumentTabResponse":{"description":"The result of adding a document tab.","type":"object","properties":{"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_AutoText":{"description":"A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this AutoText, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"},"type":{"description":"The type of this auto text.","enum":["TYPE_UNSPECIFIED","PAGE_NUMBER","PAGE_COUNT"],"type":"string"}}},"docs_v1_Background":{"description":"Represents the background of a document.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"}}},"docs_v1_BackgroundSuggestionState":{"description":"A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates whether the current background color has been modified in this suggestion.","type":"boolean"}}},"docs_v1_BatchUpdateDocumentRequest":{"description":"Request message for BatchUpdateDocument.","type":"object","properties":{"requests":{"description":"A list of updates to apply to the document.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Request"}},"writeControl":{"$ref":"#/components/schemas/docs_v1_WriteControl"}}},"docs_v1_BatchUpdateDocumentResponse":{"description":"Response message from a BatchUpdateDocument request.","type":"object","properties":{"commentUpdateState":{"description":"Whether comment updates were applied in the batch request. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENT_UPDATE_STATE_UNSPECIFIED","NO_UPDATES_REQUESTED","ALL_SAVED","ALL_FAILED_UNKNOWN_REASON"],"type":"string"},"documentId":{"description":"The ID of the document to which the updates were applied to.","type":"string"},"replies":{"description":"The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Response"}},"suggestionResponses":{"description":"The suggestions which were affected by each update. This maps 1:1 with the updates. [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/docs_v1_SuggestionResponse"}},"writeControl":{"$ref":"#/components/schemas/docs_v1_WriteControl"}}},"docs_v1_Body":{"description":"The document body. The body typically contains the full document contents except for headers, footers, and footnotes.","type":"object","properties":{"content":{"description":"The contents of the body. The indexes for the body's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}}}},"docs_v1_BookmarkLink":{"description":"A reference to a bookmark in this document.","type":"object","properties":{"id":{"description":"The ID of a bookmark in this document.","type":"string"},"tabId":{"description":"The ID of the tab containing this bookmark.","type":"string"}}},"docs_v1_Bullet":{"description":"Describes the bullet of a paragraph.","type":"object","properties":{"listId":{"description":"The ID of the list this paragraph belongs to.","type":"string"},"nestingLevel":{"description":"The nesting level of this paragraph in the list.","format":"int32","type":"integer"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_BulletSuggestionState":{"description":"A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"listIdSuggested":{"description":"Indicates if there was a suggested change to the list_id.","type":"boolean"},"nestingLevelSuggested":{"description":"Indicates if there was a suggested change to the nesting_level.","type":"boolean"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_Color":{"description":"A solid color.","type":"object","properties":{"rgbColor":{"$ref":"#/components/schemas/docs_v1_RgbColor"}}},"docs_v1_ColumnBreak":{"description":"A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this ColumnBreak, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_CommentAnchor":{"description":"One or more locations in the document that are tied to CommentThreads with the same anchorId. Note: Multiple anchors may refer to the same location. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"The ID of the comment anchor.","type":"string"},"ranges":{"description":"A collection of Ranges in the document which are tied to this anchor.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Range"}}}},"docs_v1_CommentThread":{"description":"Represents a single comment thread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"The ID of the CommentAnchor in the document that this thread is tied to. Multiple comment threads may be anchored to the same CommentAnchor.","type":"string"},"commentId":{"description":"The unique ID of the comment thread.","type":"string"},"headPost":{"$ref":"#/components/schemas/docs_v1_Post"},"plainTextQuote":{"description":"The quoted text from the document when the comment was created, formatted as plain-text.","type":"string"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Post"}},"status":{"description":"Whether the thread is open or resolved.","enum":["STATUS_UNSPECIFIED","OPEN","RESOLVED"],"type":"string"}}},"docs_v1_CreateDropdownDefinitionRequest":{"description":"Creates a new DropdownDefinition in the document.","type":"object","properties":{"dropdownDefinition":{"$ref":"#/components/schemas/docs_v1_DropdownDefinition"},"tabId":{"description":"The ID of the tab to create the dropdown definition in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_CreateDropdownDefinitionResponse":{"description":"Response message for creating a dropdown definition.","type":"object","properties":{"dropdownDefinition":{"$ref":"#/components/schemas/docs_v1_DropdownDefinition"}}},"docs_v1_CreateFooterRequest":{"description":"Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned.","type":"object","properties":{"sectionBreakLocation":{"$ref":"#/components/schemas/docs_v1_Location"},"type":{"description":"The type of footer to create.","enum":["HEADER_FOOTER_TYPE_UNSPECIFIED","DEFAULT"],"type":"string"}}},"docs_v1_CreateFooterResponse":{"description":"The result of creating a footer.","type":"object","properties":{"footerId":{"description":"The ID of the created footer.","type":"string"}}},"docs_v1_CreateFootnoteRequest":{"description":"Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_CreateFootnoteResponse":{"description":"The result of creating a footnote.","type":"object","properties":{"footnoteId":{"description":"The ID of the created footnote.","type":"string"}}},"docs_v1_CreateHeaderRequest":{"description":"Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.","type":"object","properties":{"sectionBreakLocation":{"$ref":"#/components/schemas/docs_v1_Location"},"type":{"description":"The type of header to create.","enum":["HEADER_FOOTER_TYPE_UNSPECIFIED","DEFAULT"],"type":"string"}}},"docs_v1_CreateHeaderResponse":{"description":"The result of creating a header.","type":"object","properties":{"headerId":{"description":"The ID of the created header.","type":"string"}}},"docs_v1_CreateNamedRangeRequest":{"description":"Creates a NamedRange referencing the given range.","type":"object","properties":{"name":{"description":"The name of the NamedRange. Names do not need to be unique. Names must be at least 1 character and no more than 256 characters, measured in UTF-16 code units.","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_CreateNamedRangeResponse":{"description":"The result of creating a named range.","type":"object","properties":{"namedRangeId":{"description":"The ID of the created named range.","type":"string"}}},"docs_v1_CreateParagraphBulletsRequest":{"description":"Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list.","type":"object","properties":{"bulletPreset":{"description":"The kinds of bullet glyphs to be used.","enum":["BULLET_GLYPH_PRESET_UNSPECIFIED","BULLET_DISC_CIRCLE_SQUARE","BULLET_DIAMONDX_ARROW3D_SQUARE","BULLET_CHECKBOX","BULLET_ARROW_DIAMOND_DISC","BULLET_STAR_CIRCLE_SQUARE","BULLET_ARROW3D_CIRCLE_SQUARE","BULLET_LEFTTRIANGLE_DIAMOND_DISC","BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE","BULLET_DIAMOND_CIRCLE_SQUARE","NUMBERED_DECIMAL_ALPHA_ROMAN","NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS","NUMBERED_DECIMAL_NESTED","NUMBERED_UPPERALPHA_ALPHA_ROMAN","NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL","NUMBERED_ZERODECIMAL_ALPHA_ROMAN"],"type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_CropProperties":{"description":"The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angles are 0, the image is not cropped.","type":"object","properties":{"angle":{"description":"The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.","format":"float","type":"number"},"offsetBottom":{"description":"The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.","format":"float","type":"number"},"offsetLeft":{"description":"The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.","format":"float","type":"number"},"offsetRight":{"description":"The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.","format":"float","type":"number"},"offsetTop":{"description":"The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.","format":"float","type":"number"}}},"docs_v1_CropPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"angleSuggested":{"description":"Indicates if there was a suggested change to angle.","type":"boolean"},"offsetBottomSuggested":{"description":"Indicates if there was a suggested change to offset_bottom.","type":"boolean"},"offsetLeftSuggested":{"description":"Indicates if there was a suggested change to offset_left.","type":"boolean"},"offsetRightSuggested":{"description":"Indicates if there was a suggested change to offset_right.","type":"boolean"},"offsetTopSuggested":{"description":"Indicates if there was a suggested change to offset_top.","type":"boolean"}}},"docs_v1_DateElement":{"description":"A date instance mentioned in a document.","type":"object","properties":{"dateElementProperties":{"$ref":"#/components/schemas/docs_v1_DateElementProperties"},"dateId":{"description":"Output only. The unique ID of this date.","readOnly":true,"type":"string"},"suggestedDateElementPropertiesChanges":{"description":"The suggested changes to the date element properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDateElementProperties"}},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this DateElement, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_DateElementProperties":{"description":"Properties of a DateElement.","type":"object","properties":{"dateFormat":{"description":"Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent.","enum":["DATE_FORMAT_UNSPECIFIED","DATE_FORMAT_CUSTOM","DATE_FORMAT_MONTH_DAY_ABBREVIATED","DATE_FORMAT_MONTH_DAY_FULL","DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED","DATE_FORMAT_ISO8601"],"type":"string"},"displayText":{"description":"Output only. Indicates how the DateElement is displayed in the document.","type":"string"},"locale":{"description":"The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`.","type":"string"},"timeFormat":{"description":"Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.","enum":["TIME_FORMAT_UNSPECIFIED","TIME_FORMAT_DISABLED","TIME_FORMAT_HOUR_MINUTE","TIME_FORMAT_HOUR_MINUTE_TIMEZONE"],"type":"string"},"timeZoneId":{"description":"The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`.","type":"string"},"timestamp":{"description":"The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.","format":"google-datetime","type":"string"}}},"docs_v1_DateElementPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"dateFormatSuggested":{"description":"Indicates if there was a suggested change to date_format.","type":"boolean"},"localeSuggested":{"description":"Indicates if there was a suggested change to locale.","type":"boolean"},"timeFormatSuggested":{"description":"Indicates if there was a suggested change to time_format.","type":"boolean"},"timeZoneIdSuggested":{"description":"Indicates if there was a suggested change to time_zone_id.","type":"boolean"},"timestampSuggested":{"description":"Indicates if there was a suggested change to timestamp.","type":"boolean"}}},"docs_v1_DeleteCommentReplyRequest":{"description":"Deletes a reply Post from a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains an action. - The reply post contains an assignee. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"postId":{"description":"The ID of the reply Post being deleted.","type":"string"},"suggestionId":{"description":"The ID of the SuggestionThread which the post belongs to.","type":"string"}}},"docs_v1_DeleteCommentRequest":{"description":"Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread that is being deleted.","type":"string"}}},"docs_v1_DeleteContentRangeRequest":{"description":"Deletes content from the document.","type":"object","properties":{"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_DeleteDropdownDefinitionRequest":{"description":"Deletes a DropdownDefinition. If the dropdown definition is referenced by any dropdown instances (chips) in the document, a 400 bad request error is returned.","type":"object","properties":{"dropdownDefinitionId":{"description":"The ID of the DropdownDefinition to delete.","type":"string"},"tabId":{"description":"The ID of the tab that contains the dropdown definition to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteFooterRequest":{"description":"Deletes a Footer from the document.","type":"object","properties":{"footerId":{"description":"The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section.","type":"string"},"tabId":{"description":"The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteHeaderRequest":{"description":"Deletes a Header from the document.","type":"object","properties":{"headerId":{"description":"The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section.","type":"string"},"tabId":{"description":"The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteNamedRangeRequest":{"description":"Deletes a NamedRange.","type":"object","properties":{"name":{"description":"The name of the range(s) to delete. All named ranges with the given name will be deleted.","type":"string"},"namedRangeId":{"description":"The ID of the named range to delete.","type":"string"},"tabsCriteria":{"$ref":"#/components/schemas/docs_v1_TabsCriteria"}}},"docs_v1_DeleteParagraphBulletsRequest":{"description":"Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.","type":"object","properties":{"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_DeletePositionedObjectRequest":{"description":"Deletes a PositionedObject from the document.","type":"object","properties":{"objectId":{"description":"The ID of the positioned object to delete.","type":"string"},"tabId":{"description":"The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_DeleteSuggestionRequest":{"description":"Deletes a suggestion. Returns a 403 forbidden error if the requesting user is not the author of the suggestion. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"suggestionId":{"description":"The ID of the suggestion.","type":"string"}}},"docs_v1_DeleteTabRequest":{"description":"Deletes a tab. If the tab has child tabs, they are deleted as well.","type":"object","properties":{"tabId":{"description":"The ID of the tab to delete.","type":"string"}}},"docs_v1_DeleteTableColumnRequest":{"description":"Deletes a column from a table.","type":"object","properties":{"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_DeleteTableRowRequest":{"description":"Deletes a row from a table.","type":"object","properties":{"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_Dimension":{"description":"A magnitude in a single direction in the specified units.","type":"object","properties":{"magnitude":{"description":"The magnitude.","format":"double","type":"number"},"unit":{"description":"The units for magnitude.","enum":["UNIT_UNSPECIFIED","PT"],"type":"string"}}},"docs_v1_Document":{"description":"A Google Docs document.","type":"object","properties":{"body":{"$ref":"#/components/schemas/docs_v1_Body"},"comments":{"description":"Output only. The comments associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/docs_v1_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the document. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"documentId":{"description":"Output only. The ID of the document.","type":"string"},"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"footers":{"description":"Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footer"}},"footnotes":{"description":"Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footnote"}},"headers":{"description":"Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Header"}},"inlineObjects":{"description":"Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_InlineObject"}},"lists":{"description":"Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_List"}},"namedRanges":{"description":"Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_NamedRanges"}},"namedStyles":{"$ref":"#/components/schemas/docs_v1_NamedStyles"},"positionedObjects":{"description":"Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObject"}},"revisionId":{"description":"Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.","type":"string"},"suggestedDocumentStyleChanges":{"description":"Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDocumentStyle"}},"suggestedNamedStylesChanges":{"description":"Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedNamedStyles"}},"suggestions":{"description":"Output only. The suggestions associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/docs_v1_SuggestionThread"}},"suggestionsViewMode":{"description":"Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.","enum":["DEFAULT_FOR_CURRENT_ACCESS","SUGGESTIONS_INLINE","PREVIEW_SUGGESTIONS_ACCEPTED","PREVIEW_WITHOUT_SUGGESTIONS"],"type":"string"},"tabs":{"description":"Output only. Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Tab"}},"title":{"description":"The title of the document.","type":"string"}}},"docs_v1_DocumentFormat":{"description":"Represents document-level format settings.","type":"object","properties":{"documentMode":{"description":"Whether the document has pages or is pageless.","enum":["DOCUMENT_MODE_UNSPECIFIED","PAGES","PAGELESS"],"type":"string"}}},"docs_v1_DocumentStyle":{"description":"The style of the document.","type":"object","properties":{"background":{"$ref":"#/components/schemas/docs_v1_Background"},"defaultFooterId":{"description":"The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"defaultHeaderId":{"description":"The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"documentFormat":{"$ref":"#/components/schemas/docs_v1_DocumentFormat"},"evenPageFooterId":{"description":"The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"evenPageHeaderId":{"description":"The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageFooterId":{"description":"The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageHeaderId":{"description":"The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"flipPageOrientation":{"description":"Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.","type":"boolean"},"marginBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginFooter":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginHeader":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"pageNumberStart":{"description":"The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.","format":"int32","type":"integer"},"pageSize":{"$ref":"#/components/schemas/docs_v1_Size"},"useCustomHeaderFooterMargins":{"description":"Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"boolean"},"useEvenPageHeaderFooter":{"description":"Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.","type":"boolean"},"useFirstPageHeaderFooter":{"description":"Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.","type":"boolean"}}},"docs_v1_DocumentStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundSuggestionState":{"$ref":"#/components/schemas/docs_v1_BackgroundSuggestionState"},"defaultFooterIdSuggested":{"description":"Indicates if there was a suggested change to default_footer_id.","type":"boolean"},"defaultHeaderIdSuggested":{"description":"Indicates if there was a suggested change to default_header_id.","type":"boolean"},"evenPageFooterIdSuggested":{"description":"Indicates if there was a suggested change to even_page_footer_id.","type":"boolean"},"evenPageHeaderIdSuggested":{"description":"Indicates if there was a suggested change to even_page_header_id.","type":"boolean"},"firstPageFooterIdSuggested":{"description":"Indicates if there was a suggested change to first_page_footer_id.","type":"boolean"},"firstPageHeaderIdSuggested":{"description":"Indicates if there was a suggested change to first_page_header_id.","type":"boolean"},"flipPageOrientationSuggested":{"description":"Optional. Indicates if there was a suggested change to flip_page_orientation.","type":"boolean"},"marginBottomSuggested":{"description":"Indicates if there was a suggested change to margin_bottom.","type":"boolean"},"marginFooterSuggested":{"description":"Indicates if there was a suggested change to margin_footer.","type":"boolean"},"marginHeaderSuggested":{"description":"Indicates if there was a suggested change to margin_header.","type":"boolean"},"marginLeftSuggested":{"description":"Indicates if there was a suggested change to margin_left.","type":"boolean"},"marginRightSuggested":{"description":"Indicates if there was a suggested change to margin_right.","type":"boolean"},"marginTopSuggested":{"description":"Indicates if there was a suggested change to margin_top.","type":"boolean"},"pageNumberStartSuggested":{"description":"Indicates if there was a suggested change to page_number_start.","type":"boolean"},"pageSizeSuggestionState":{"$ref":"#/components/schemas/docs_v1_SizeSuggestionState"},"useCustomHeaderFooterMarginsSuggested":{"description":"Indicates if there was a suggested change to use_custom_header_footer_margins.","type":"boolean"},"useEvenPageHeaderFooterSuggested":{"description":"Indicates if there was a suggested change to use_even_page_header_footer.","type":"boolean"},"useFirstPageHeaderFooterSuggested":{"description":"Indicates if there was a suggested change to use_first_page_header_footer.","type":"boolean"}}},"docs_v1_DocumentTab":{"description":"A tab with document contents.","type":"object","properties":{"body":{"$ref":"#/components/schemas/docs_v1_Body"},"commentAnchors":{"description":"The comment anchors in a document tab, keyed by anchor ID. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_CommentAnchor"}},"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"dropdownDefinitions":{"description":"The dropdown definitions in a document tab, keyed by dropdown definition ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinition"}},"footers":{"description":"The footers in the document tab, keyed by footer ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footer"}},"footnotes":{"description":"The footnotes in the document tab, keyed by footnote ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Footnote"}},"headers":{"description":"The headers in the document tab, keyed by header ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_Header"}},"inlineObjects":{"description":"The inline objects in the document tab, keyed by object ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_InlineObject"}},"lists":{"description":"The lists in the document tab, keyed by list ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_List"}},"namedRanges":{"description":"The named ranges in the document tab, keyed by name.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_NamedRanges"}},"namedStyles":{"$ref":"#/components/schemas/docs_v1_NamedStyles"},"positionedObjects":{"description":"The positioned objects in the document tab, keyed by object ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObject"}},"suggestedDocumentStyleChanges":{"description":"The suggested changes to the style of the document tab, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDocumentStyle"}},"suggestedNamedStylesChanges":{"description":"The suggested changes to the named styles of the document tab, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedNamedStyles"}}}},"docs_v1_Dropdown":{"description":"A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options.","type":"object","properties":{"dropdownId":{"description":"The ID of this dropdown.","type":"string"},"dropdownProperties":{"$ref":"#/components/schemas/docs_v1_DropdownProperties"},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedDropdownPropertiesChanges":{"description":"The suggested properties changes to this dropdown, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDropdownProperties"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this dropdown, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_DropdownDefinition":{"description":"A dropdown definition in the document.","type":"object","properties":{"dropdownDefinitionId":{"description":"The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated.","type":"string"},"dropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionProperties"},"suggestedDeletionId":{"description":"ID for suggestion that deletes this dropdown definition.","type":"string"},"suggestedDropdownDefinitionPropertiesChanges":{"description":"Suggested property changes to this definition, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedDropdownDefinitionProperties"}},"suggestedInsertionId":{"description":"ID for suggestion that inserts this dropdown definition.","type":"string"}}},"docs_v1_DropdownDefinitionProperties":{"description":"Properties of a dropdown definition.","type":"object","properties":{"options":{"description":"The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_DropdownOption"}},"title":{"description":"The title of the dropdown definition.","type":"string"}}},"docs_v1_DropdownDefinitionPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"optionsSuggested":{"description":"Indicates if there was a suggested change to options.","type":"boolean"},"titleSuggested":{"description":"Indicates if there was a suggested change to title.","type":"boolean"}}},"docs_v1_DropdownOption":{"description":"An option in a Dropdown.","type":"object","properties":{"displayValue":{"description":"The display value of this dropdown option.","type":"string"},"optionId":{"description":"The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated.","type":"string"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_DropdownProperties":{"description":"Properties specific to a dropdown.","type":"object","properties":{"displayValue":{"description":"The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes.","type":"string"},"dropdownDefinitionId":{"description":"The ID of the DropdownDefinition that defines the options for this dropdown.","type":"string"},"selectedOptionId":{"description":"The ID of the selected option in this dropdown.","type":"string"}}},"docs_v1_DropdownPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"selectedOptionIdSuggested":{"description":"Indicates if there was a suggested change to selected_option_id.","type":"boolean"}}},"docs_v1_EmbeddedDrawingProperties":{"description":"The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.","type":"object"},"docs_v1_EmbeddedDrawingPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object"},"docs_v1_EmbeddedObject":{"description":"An embedded object in the document.","type":"object","properties":{"description":{"description":"The description of the embedded object. The `title` and `description` are both combined to display alt text.","type":"string"},"embeddedDrawingProperties":{"$ref":"#/components/schemas/docs_v1_EmbeddedDrawingProperties"},"embeddedObjectBorder":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectBorder"},"imageProperties":{"$ref":"#/components/schemas/docs_v1_ImageProperties"},"linkedContentReference":{"$ref":"#/components/schemas/docs_v1_LinkedContentReference"},"marginBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"size":{"$ref":"#/components/schemas/docs_v1_Size"},"title":{"description":"The title of the embedded object. The `title` and `description` are both combined to display alt text.","type":"string"}}},"docs_v1_EmbeddedObjectBorder":{"description":"A border around an EmbeddedObject.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH"],"type":"string"},"propertyState":{"description":"The property state of the border property.","enum":["RENDERED","NOT_RENDERED"],"type":"string"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_EmbeddedObjectBorderSuggestionState":{"description":"A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"colorSuggested":{"description":"Indicates if there was a suggested change to color.","type":"boolean"},"dashStyleSuggested":{"description":"Indicates if there was a suggested change to dash_style.","type":"boolean"},"propertyStateSuggested":{"description":"Indicates if there was a suggested change to property_state.","type":"boolean"},"widthSuggested":{"description":"Indicates if there was a suggested change to width.","type":"boolean"}}},"docs_v1_EmbeddedObjectSuggestionState":{"description":"A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"descriptionSuggested":{"description":"Indicates if there was a suggested change to description.","type":"boolean"},"embeddedDrawingPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedDrawingPropertiesSuggestionState"},"embeddedObjectBorderSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectBorderSuggestionState"},"imagePropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_ImagePropertiesSuggestionState"},"linkedContentReferenceSuggestionState":{"$ref":"#/components/schemas/docs_v1_LinkedContentReferenceSuggestionState"},"marginBottomSuggested":{"description":"Indicates if there was a suggested change to margin_bottom.","type":"boolean"},"marginLeftSuggested":{"description":"Indicates if there was a suggested change to margin_left.","type":"boolean"},"marginRightSuggested":{"description":"Indicates if there was a suggested change to margin_right.","type":"boolean"},"marginTopSuggested":{"description":"Indicates if there was a suggested change to margin_top.","type":"boolean"},"sizeSuggestionState":{"$ref":"#/components/schemas/docs_v1_SizeSuggestionState"},"titleSuggested":{"description":"Indicates if there was a suggested change to title.","type":"boolean"}}},"docs_v1_EndOfSegmentLocation":{"description":"Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment.","type":"object","properties":{"segmentId":{"description":"The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.","type":"string"},"tabId":{"description":"The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_Equation":{"description":"A ParagraphElement representing an equation.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}}}},"docs_v1_Footer":{"description":"A document footer.","type":"object","properties":{"content":{"description":"The contents of the footer. The indexes for a footer's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"footerId":{"description":"The ID of the footer.","type":"string"}}},"docs_v1_Footnote":{"description":"A document footnote.","type":"object","properties":{"content":{"description":"The contents of the footnote. The indexes for a footnote's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"footnoteId":{"description":"The ID of the footnote.","type":"string"}}},"docs_v1_FootnoteReference":{"description":"A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote.","type":"object","properties":{"footnoteId":{"description":"The ID of the footnote that contains the content of this footnote reference.","type":"string"},"footnoteNumber":{"description":"The rendered number of this footnote.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this FootnoteReference, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_Header":{"description":"A document header.","type":"object","properties":{"content":{"description":"The contents of the header. The indexes for a header's content begin at zero.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"headerId":{"description":"The ID of the header.","type":"string"}}},"docs_v1_HeadingLink":{"description":"A reference to a heading in this document.","type":"object","properties":{"id":{"description":"The ID of a heading in this document.","type":"string"},"tabId":{"description":"The ID of the tab containing this heading.","type":"string"}}},"docs_v1_HorizontalRule":{"description":"A ParagraphElement representing a horizontal line.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this HorizontalRule, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_ImageProperties":{"description":"The properties of an image.","type":"object","properties":{"angle":{"description":"The clockwise rotation angle of the image, in radians.","format":"float","type":"number"},"brightness":{"description":"The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.","format":"float","type":"number"},"contentUri":{"description":"A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.","type":"string"},"contrast":{"description":"The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.","format":"float","type":"number"},"cropProperties":{"$ref":"#/components/schemas/docs_v1_CropProperties"},"sourceUri":{"description":"The source URI is the URI used to insert the image. The source URI can be empty.","type":"string"},"transparency":{"description":"The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.","format":"float","type":"number"}}},"docs_v1_ImagePropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"angleSuggested":{"description":"Indicates if there was a suggested change to angle.","type":"boolean"},"brightnessSuggested":{"description":"Indicates if there was a suggested change to brightness.","type":"boolean"},"contentUriSuggested":{"description":"Indicates if there was a suggested change to content_uri.","type":"boolean"},"contrastSuggested":{"description":"Indicates if there was a suggested change to contrast.","type":"boolean"},"cropPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_CropPropertiesSuggestionState"},"sourceUriSuggested":{"description":"Indicates if there was a suggested change to source_uri.","type":"boolean"},"transparencySuggested":{"description":"Indicates if there was a suggested change to transparency.","type":"boolean"}}},"docs_v1_InlineObject":{"description":"An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.","type":"object","properties":{"inlineObjectProperties":{"$ref":"#/components/schemas/docs_v1_InlineObjectProperties"},"objectId":{"description":"The ID of this inline object. Can be used to update an object’s properties.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInlineObjectPropertiesChanges":{"description":"The suggested changes to the inline object properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedInlineObjectProperties"}},"suggestedInsertionId":{"description":"The suggested insertion ID. If empty, then this is not a suggested insertion.","type":"string"}}},"docs_v1_InlineObjectElement":{"description":"A ParagraphElement that contains an InlineObject.","type":"object","properties":{"inlineObjectId":{"description":"The ID of the InlineObject this element contains.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this InlineObject, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_InlineObjectProperties":{"description":"Properties of an InlineObject.","type":"object","properties":{"embeddedObject":{"$ref":"#/components/schemas/docs_v1_EmbeddedObject"}}},"docs_v1_InlineObjectPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"embeddedObjectSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectSuggestionState"}}},"docs_v1_InsertCommentRequest":{"description":"Inserts a CommentThread into the document. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmailAddress":{"description":"Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units.","type":"string"},"content":{"description":"The text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_InsertCommentResponse":{"description":"Response message for inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentThread":{"$ref":"#/components/schemas/docs_v1_CommentThread"}}},"docs_v1_InsertDateRequest":{"description":"Inserts a date at the specified location.","type":"object","properties":{"dateElementProperties":{"$ref":"#/components/schemas/docs_v1_DateElementProperties"},"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_InsertDropdownRequest":{"description":"Inserts a Dropdown at the specified location.","type":"object","properties":{"dropdownDefinitionId":{"description":"Required. The DropdownDefinition ID.","type":"string"},"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"selectedOptionId":{"description":"Optional initial value for the dropdown. If this field is not specified, the new dropdown will default to selecting the first option defined in the dropdown definition. If this field is specified but does not reference a valid option in the dropdown definition, a 400 bad request error is returned.","type":"string"}}},"docs_v1_InsertDropdownResponse":{"description":"The result of inserting a Dropdown.","type":"object","properties":{"dropdown":{"$ref":"#/components/schemas/docs_v1_Dropdown"}}},"docs_v1_InsertInlineImageRequest":{"description":"Inserts an InlineObject containing an image at the given location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"objectSize":{"$ref":"#/components/schemas/docs_v1_Size"},"uri":{"description":"The image URI. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI must be publicly accessible and at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field.","type":"string"}}},"docs_v1_InsertInlineImageResponse":{"description":"The result of inserting an inline image.","type":"object","properties":{"objectId":{"description":"The ID of the created InlineObject.","type":"string"}}},"docs_v1_InsertInlineSheetsChartResponse":{"description":"The result of inserting an embedded Google Sheets chart.","type":"object","properties":{"objectId":{"description":"The object ID of the inserted chart.","type":"string"}}},"docs_v1_InsertPageBreakRequest":{"description":"Inserts a page break followed by a newline at the specified location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_InsertPersonRequest":{"description":"Inserts a person mention.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"personProperties":{"$ref":"#/components/schemas/docs_v1_PersonProperties"}}},"docs_v1_InsertRichLinkRequest":{"description":"Inserts a RichLink at the specified location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"richLinkProperties":{"$ref":"#/components/schemas/docs_v1_RichLinkProperties"}}},"docs_v1_InsertSectionBreakRequest":{"description":"Inserts a section break at the given location. A newline character will be inserted before the section break.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"sectionType":{"description":"The type of section to insert.","enum":["SECTION_TYPE_UNSPECIFIED","CONTINUOUS","NEXT_PAGE"],"type":"string"}}},"docs_v1_InsertTableColumnRequest":{"description":"Inserts an empty column into a table.","type":"object","properties":{"insertRight":{"description":"Whether to insert new column to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left.","type":"boolean"},"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_InsertTableRequest":{"description":"Inserts a table at the specified location. A newline character will be inserted before the inserted table.","type":"object","properties":{"columns":{"description":"The number of columns in the table.","format":"int32","type":"integer"},"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"rows":{"description":"The number of rows in the table.","format":"int32","type":"integer"}}},"docs_v1_InsertTableRowRequest":{"description":"Inserts an empty row into a table.","type":"object","properties":{"insertBelow":{"description":"Whether to insert new row below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell.","type":"boolean"},"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_InsertTextRequest":{"description":"Inserts text at the specified location.","type":"object","properties":{"endOfSegmentLocation":{"$ref":"#/components/schemas/docs_v1_EndOfSegmentLocation"},"location":{"$ref":"#/components/schemas/docs_v1_Location"},"text":{"description":"The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text.","type":"string"}}},"docs_v1_Link":{"description":"A reference to another portion of a document or an external URL resource.","type":"object","properties":{"bookmark":{"$ref":"#/components/schemas/docs_v1_BookmarkLink"},"bookmarkId":{"description":"The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.","type":"string"},"heading":{"$ref":"#/components/schemas/docs_v1_HeadingLink"},"headingId":{"description":"The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.","type":"string"},"tabId":{"description":"The ID of a tab in this document.","type":"string"},"url":{"description":"An external URL.","type":"string"}}},"docs_v1_LinkedContentReference":{"description":"A reference to the external linked source content.","type":"object","properties":{"sheetsChartReference":{"$ref":"#/components/schemas/docs_v1_SheetsChartReference"}}},"docs_v1_LinkedContentReferenceSuggestionState":{"description":"A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"sheetsChartReferenceSuggestionState":{"$ref":"#/components/schemas/docs_v1_SheetsChartReferenceSuggestionState"}}},"docs_v1_List":{"description":"A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.","type":"object","properties":{"listProperties":{"$ref":"#/components/schemas/docs_v1_ListProperties"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this list.","type":"array","items":{"type":"string"}},"suggestedInsertionId":{"description":"The suggested insertion ID. If empty, then this is not a suggested insertion.","type":"string"},"suggestedListPropertiesChanges":{"description":"The suggested changes to the list properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedListProperties"}}}},"docs_v1_ListProperties":{"description":"The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list.","type":"object","properties":{"nestingLevels":{"description":"Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NestingLevel"}}}},"docs_v1_ListPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"nestingLevelsSuggestionStates":{"description":"A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NestingLevelSuggestionState"}}}},"docs_v1_Location":{"description":"A particular location in the document.","type":"object","properties":{"index":{"description":"The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id.","format":"int32","type":"integer"},"segmentId":{"description":"The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.","type":"string"},"tabId":{"description":"The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_MergeTableCellsRequest":{"description":"Merges cells in a Table.","type":"object","properties":{"tableRange":{"$ref":"#/components/schemas/docs_v1_TableRange"}}},"docs_v1_NamedRange":{"description":"A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.","type":"object","properties":{"name":{"description":"The name of the named range.","type":"string"},"namedRangeId":{"description":"The ID of the named range.","type":"string"},"ranges":{"description":"The ranges that belong to this named range.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Range"}}}},"docs_v1_NamedRanges":{"description":"A collection of all the NamedRanges in the document that share a given name.","type":"object","properties":{"name":{"description":"The name that all the named ranges share.","type":"string"},"namedRanges":{"description":"The NamedRanges that share the same name.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NamedRange"}}}},"docs_v1_NamedStyle":{"description":"A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.","type":"object","properties":{"namedStyleType":{"description":"The type of this named style.","enum":["NAMED_STYLE_TYPE_UNSPECIFIED","NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6"],"type":"string"},"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_NamedStyleSuggestionState":{"description":"A suggestion state of a NamedStyle message.","type":"object","properties":{"namedStyleType":{"description":"The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle.","enum":["NAMED_STYLE_TYPE_UNSPECIFIED","NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6"],"type":"string"},"paragraphStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_ParagraphStyleSuggestionState"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_NamedStyles":{"description":"The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles.","type":"object","properties":{"styles":{"description":"The named styles. There's an entry for each of the possible named style types.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NamedStyle"}}}},"docs_v1_NamedStylesSuggestionState":{"description":"The suggestion state of a NamedStyles message.","type":"object","properties":{"stylesSuggestionStates":{"description":"A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_NamedStyleSuggestionState"}}}},"docs_v1_NestingLevel":{"description":"Contains properties describing the look and feel of a list bullet at a given level of nesting.","type":"object","properties":{"bulletAlignment":{"description":"The alignment of the bullet within the space allotted for rendering the bullet.","enum":["BULLET_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"glyphFormat":{"description":"The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.","type":"string"},"glyphSymbol":{"description":"A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.","type":"string"},"glyphType":{"description":"The type of glyph used by bullets when paragraphs at this level of nesting is ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to the list item's order within the list.","enum":["GLYPH_TYPE_UNSPECIFIED","NONE","DECIMAL","ZERO_DECIMAL","UPPER_ALPHA","ALPHA","UPPER_ROMAN","ROMAN"],"type":"string"},"indentFirstLine":{"$ref":"#/components/schemas/docs_v1_Dimension"},"indentStart":{"$ref":"#/components/schemas/docs_v1_Dimension"},"startNumber":{"description":"The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.","format":"int32","type":"integer"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_NestingLevelSuggestionState":{"description":"A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"bulletAlignmentSuggested":{"description":"Indicates if there was a suggested change to bullet_alignment.","type":"boolean"},"glyphFormatSuggested":{"description":"Indicates if there was a suggested change to glyph_format.","type":"boolean"},"glyphSymbolSuggested":{"description":"Indicates if there was a suggested change to glyph_symbol.","type":"boolean"},"glyphTypeSuggested":{"description":"Indicates if there was a suggested change to glyph_type.","type":"boolean"},"indentFirstLineSuggested":{"description":"Indicates if there was a suggested change to indent_first_line.","type":"boolean"},"indentStartSuggested":{"description":"Indicates if there was a suggested change to indent_start.","type":"boolean"},"startNumberSuggested":{"description":"Indicates if there was a suggested change to start_number.","type":"boolean"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_ObjectReferences":{"description":"A collection of object IDs.","type":"object","properties":{"objectIds":{"description":"The object IDs.","type":"array","items":{"type":"string"}}}},"docs_v1_OptionalColor":{"description":"A color that can either be fully opaque or fully transparent.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_Color"}}},"docs_v1_PageBreak":{"description":"A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page.","type":"object","properties":{"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this PageBreak, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_Paragraph":{"description":"A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character.","type":"object","properties":{"bullet":{"$ref":"#/components/schemas/docs_v1_Bullet"},"elements":{"description":"The content of the paragraph, broken down into its component parts.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_ParagraphElement"}},"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"positionedObjectIds":{"description":"The IDs of the positioned objects tethered to this paragraph.","type":"array","items":{"type":"string"}},"suggestedBulletChanges":{"description":"The suggested changes to this paragraph's bullet.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedBullet"}},"suggestedParagraphStyleChanges":{"description":"The suggested paragraph style changes to this paragraph, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedParagraphStyle"}},"suggestedPositionedObjectIds":{"description":"The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_ObjectReferences"}}}},"docs_v1_ParagraphBorder":{"description":"A border around a paragraph.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH"],"type":"string"},"padding":{"$ref":"#/components/schemas/docs_v1_Dimension"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_ParagraphElement":{"description":"A ParagraphElement describes content within a Paragraph.","type":"object","properties":{"autoText":{"$ref":"#/components/schemas/docs_v1_AutoText"},"columnBreak":{"$ref":"#/components/schemas/docs_v1_ColumnBreak"},"dateElement":{"$ref":"#/components/schemas/docs_v1_DateElement"},"dropdown":{"$ref":"#/components/schemas/docs_v1_Dropdown"},"endIndex":{"description":"The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"equation":{"$ref":"#/components/schemas/docs_v1_Equation"},"footnoteReference":{"$ref":"#/components/schemas/docs_v1_FootnoteReference"},"horizontalRule":{"$ref":"#/components/schemas/docs_v1_HorizontalRule"},"inlineObjectElement":{"$ref":"#/components/schemas/docs_v1_InlineObjectElement"},"pageBreak":{"$ref":"#/components/schemas/docs_v1_PageBreak"},"person":{"$ref":"#/components/schemas/docs_v1_Person"},"richLink":{"$ref":"#/components/schemas/docs_v1_RichLink"},"startIndex":{"description":"The zero-based start index of this paragraph element, in UTF-16 code units.","format":"int32","type":"integer"},"textRun":{"$ref":"#/components/schemas/docs_v1_TextRun"}}},"docs_v1_ParagraphStyle":{"description":"Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor.","type":"object","properties":{"alignment":{"description":"The text alignment for this paragraph.","enum":["ALIGNMENT_UNSPECIFIED","START","CENTER","END","JUSTIFIED"],"type":"string"},"avoidWidowAndOrphan":{"description":"Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.","type":"boolean"},"borderBetween":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderBottom":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderLeft":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderRight":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"borderTop":{"$ref":"#/components/schemas/docs_v1_ParagraphBorder"},"direction":{"description":"The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.","enum":["CONTENT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"headingId":{"description":"The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.","type":"string"},"indentEnd":{"$ref":"#/components/schemas/docs_v1_Dimension"},"indentFirstLine":{"$ref":"#/components/schemas/docs_v1_Dimension"},"indentStart":{"$ref":"#/components/schemas/docs_v1_Dimension"},"keepLinesTogether":{"description":"Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.","type":"boolean"},"keepWithNext":{"description":"Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.","type":"boolean"},"lineSpacing":{"description":"The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.","format":"float","type":"number"},"namedStyleType":{"description":"The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.","enum":["NAMED_STYLE_TYPE_UNSPECIFIED","NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6"],"type":"string"},"pageBreakBefore":{"description":"Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.","type":"boolean"},"shading":{"$ref":"#/components/schemas/docs_v1_Shading"},"spaceAbove":{"$ref":"#/components/schemas/docs_v1_Dimension"},"spaceBelow":{"$ref":"#/components/schemas/docs_v1_Dimension"},"spacingMode":{"description":"The spacing mode for the paragraph.","enum":["SPACING_MODE_UNSPECIFIED","NEVER_COLLAPSE","COLLAPSE_LISTS"],"type":"string"},"tabStops":{"description":"A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TabStop"}}}},"docs_v1_ParagraphStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"alignmentSuggested":{"description":"Indicates if there was a suggested change to alignment.","type":"boolean"},"avoidWidowAndOrphanSuggested":{"description":"Indicates if there was a suggested change to avoid_widow_and_orphan.","type":"boolean"},"borderBetweenSuggested":{"description":"Indicates if there was a suggested change to border_between.","type":"boolean"},"borderBottomSuggested":{"description":"Indicates if there was a suggested change to border_bottom.","type":"boolean"},"borderLeftSuggested":{"description":"Indicates if there was a suggested change to border_left.","type":"boolean"},"borderRightSuggested":{"description":"Indicates if there was a suggested change to border_right.","type":"boolean"},"borderTopSuggested":{"description":"Indicates if there was a suggested change to border_top.","type":"boolean"},"directionSuggested":{"description":"Indicates if there was a suggested change to direction.","type":"boolean"},"headingIdSuggested":{"description":"Indicates if there was a suggested change to heading_id.","type":"boolean"},"indentEndSuggested":{"description":"Indicates if there was a suggested change to indent_end.","type":"boolean"},"indentFirstLineSuggested":{"description":"Indicates if there was a suggested change to indent_first_line.","type":"boolean"},"indentStartSuggested":{"description":"Indicates if there was a suggested change to indent_start.","type":"boolean"},"keepLinesTogetherSuggested":{"description":"Indicates if there was a suggested change to keep_lines_together.","type":"boolean"},"keepWithNextSuggested":{"description":"Indicates if there was a suggested change to keep_with_next.","type":"boolean"},"lineSpacingSuggested":{"description":"Indicates if there was a suggested change to line_spacing.","type":"boolean"},"namedStyleTypeSuggested":{"description":"Indicates if there was a suggested change to named_style_type.","type":"boolean"},"pageBreakBeforeSuggested":{"description":"Indicates if there was a suggested change to page_break_before.","type":"boolean"},"shadingSuggestionState":{"$ref":"#/components/schemas/docs_v1_ShadingSuggestionState"},"spaceAboveSuggested":{"description":"Indicates if there was a suggested change to space_above.","type":"boolean"},"spaceBelowSuggested":{"description":"Indicates if there was a suggested change to space_below.","type":"boolean"},"spacingModeSuggested":{"description":"Indicates if there was a suggested change to spacing_mode.","type":"boolean"}}},"docs_v1_Person":{"description":"A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address.","type":"object","properties":{"personId":{"description":"Output only. The unique ID of this link.","readOnly":true,"type":"string"},"personProperties":{"$ref":"#/components/schemas/docs_v1_PersonProperties"},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this Person, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_PersonProperties":{"description":"Properties specific to a linked Person.","type":"object","properties":{"email":{"description":"The email address linked to this Person. This field is always present.","type":"string"},"name":{"description":"The name of the person if it's displayed in the link text instead of the person's email address.","type":"string"}}},"docs_v1_PinTableHeaderRowsRequest":{"description":"Updates the number of pinned table header rows in a table.","type":"object","properties":{"pinnedHeaderRowsCount":{"description":"The number of table rows to pin, where 0 implies that all rows are unpinned.","format":"int32","type":"integer"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_PositionedObject":{"description":"An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.","type":"object","properties":{"objectId":{"description":"The ID of this positioned object.","type":"string"},"positionedObjectProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObjectProperties"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionId":{"description":"The suggested insertion ID. If empty, then this is not a suggested insertion.","type":"string"},"suggestedPositionedObjectPropertiesChanges":{"description":"The suggested changes to the positioned object properties, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedPositionedObjectProperties"}}}},"docs_v1_PositionedObjectPositioning":{"description":"The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to.","type":"object","properties":{"layout":{"description":"The layout of this positioned object.","enum":["POSITIONED_OBJECT_LAYOUT_UNSPECIFIED","WRAP_TEXT","BREAK_LEFT","BREAK_RIGHT","BREAK_LEFT_RIGHT","IN_FRONT_OF_TEXT","BEHIND_TEXT"],"type":"string"},"leftOffset":{"$ref":"#/components/schemas/docs_v1_Dimension"},"topOffset":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_PositionedObjectPositioningSuggestionState":{"description":"A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"layoutSuggested":{"description":"Indicates if there was a suggested change to layout.","type":"boolean"},"leftOffsetSuggested":{"description":"Indicates if there was a suggested change to left_offset.","type":"boolean"},"topOffsetSuggested":{"description":"Indicates if there was a suggested change to top_offset.","type":"boolean"}}},"docs_v1_PositionedObjectProperties":{"description":"Properties of a PositionedObject.","type":"object","properties":{"embeddedObject":{"$ref":"#/components/schemas/docs_v1_EmbeddedObject"},"positioning":{"$ref":"#/components/schemas/docs_v1_PositionedObjectPositioning"}}},"docs_v1_PositionedObjectPropertiesSuggestionState":{"description":"A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"embeddedObjectSuggestionState":{"$ref":"#/components/schemas/docs_v1_EmbeddedObjectSuggestionState"},"positioningSuggestionState":{"$ref":"#/components/schemas/docs_v1_PositionedObjectPositioningSuggestionState"}}},"docs_v1_Post":{"description":"Represents a single post in a comment or suggestion thread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmail":{"description":"Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - The parent thread is a SuggestionThread. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assigneeEmail` exceeds 2048 UTF-8 code units.","type":"string"},"author":{"$ref":"#/components/schemas/docs_v1_PostAuthor"},"commentAction":{"description":"Optional. The action type for comment posts.","enum":["COMMENT_ACTION_TYPE_UNSPECIFIED","NO_COMMENT_ACTION_CHANGE","RESOLVE","REOPEN"],"type":"string"},"content":{"description":"The content of the post. Required to be non-empty if commentAction is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.","type":"string"},"contentHtml":{"description":"Output only. The content of the post as HTML.","type":"string"},"createTime":{"description":"Output only. The time the post was created.","format":"google-datetime","type":"string"},"deleted":{"description":"Output only. Whether the post is deleted. If `true`, content and author fields will be empty.","type":"boolean"},"fromCopiedDocument":{"description":"Output only. Whether the post is from a copied document. This field cannot be set directly by callers.","type":"boolean"},"fromDocumentComparison":{"description":"Output only. Whether the post is from a document comparison. This field cannot be set directly by callers.","type":"boolean"},"fromImportedDocument":{"description":"Output only. Whether the post is from an imported document. This field cannot be set directly by callers.","type":"boolean"},"postId":{"description":"Output only. The unique ID of the post.","type":"string"},"suggestionAction":{"description":"Output only. The action type for suggestion posts.","enum":["SUGGESTION_ACTION_TYPE_UNSPECIFIED","NO_SUGGESTION_ACTION_CHANGE","ACCEPT","REJECT"],"type":"string"},"updateTime":{"description":"Output only. The time the post was last updated.","format":"google-datetime","type":"string"}}},"docs_v1_PostAuthor":{"description":"Represents a user who authored a comment or suggestion post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anonymous":{"description":"Whether the user is anonymous.","type":"boolean"},"displayName":{"description":"The display name of the user. May be absent if the author is anonymous.","type":"string"},"me":{"description":"Whether the user is the authenticated user making the request.","type":"boolean"},"user":{"description":"The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported document.","type":"string"}}},"docs_v1_Range":{"description":"Specifies a contiguous range of text.","type":"object","properties":{"endIndex":{"description":"The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"},"segmentId":{"description":"The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.","type":"string"},"startIndex":{"description":"The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"},"tabId":{"description":"The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_RejectSuggestionRequest":{"description":"Rejects a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document and is not the author of the suggestion. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"suggestionId":{"description":"The ID of the suggestion.","type":"string"}}},"docs_v1_ReplaceAllTextRequest":{"description":"Replaces all instances of text matching a criteria with replace text.","type":"object","properties":{"containsText":{"$ref":"#/components/schemas/docs_v1_SubstringMatchCriteria"},"replaceText":{"description":"The text that will replace the matched text.","type":"string"},"tabsCriteria":{"$ref":"#/components/schemas/docs_v1_TabsCriteria"}}},"docs_v1_ReplaceAllTextResponse":{"description":"The result of replacing text.","type":"object","properties":{"occurrencesChanged":{"description":"The number of occurrences changed by replacing all text.","format":"int32","type":"integer"}}},"docs_v1_ReplaceImageRequest":{"description":"Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor.","type":"object","properties":{"imageObjectId":{"description":"The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.","type":"string"},"imageReplaceMethod":{"description":"The replacement method.","enum":["IMAGE_REPLACE_METHOD_UNSPECIFIED","CENTER_CROP"],"type":"string"},"tabId":{"description":"The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"},"uri":{"description":"The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.","type":"string"}}},"docs_v1_ReplaceNamedRangeContentRequest":{"description":"Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned.","type":"object","properties":{"namedRangeId":{"description":"The ID of the named range whose content will be replaced. If there is no named range with the given ID a 400 bad request error is returned.","type":"string"},"namedRangeName":{"description":"The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.","type":"string"},"tabsCriteria":{"$ref":"#/components/schemas/docs_v1_TabsCriteria"},"text":{"description":"Replaces the content of the specified named range(s) with the given text.","type":"string"}}},"docs_v1_Request":{"description":"A single update to apply to a document.","type":"object","properties":{"acceptSuggestion":{"$ref":"#/components/schemas/docs_v1_AcceptSuggestionRequest"},"addCommentReply":{"$ref":"#/components/schemas/docs_v1_AddCommentReplyRequest"},"addDocumentTab":{"$ref":"#/components/schemas/docs_v1_AddDocumentTabRequest"},"createDropdownDefinition":{"$ref":"#/components/schemas/docs_v1_CreateDropdownDefinitionRequest"},"createFooter":{"$ref":"#/components/schemas/docs_v1_CreateFooterRequest"},"createFootnote":{"$ref":"#/components/schemas/docs_v1_CreateFootnoteRequest"},"createHeader":{"$ref":"#/components/schemas/docs_v1_CreateHeaderRequest"},"createNamedRange":{"$ref":"#/components/schemas/docs_v1_CreateNamedRangeRequest"},"createParagraphBullets":{"$ref":"#/components/schemas/docs_v1_CreateParagraphBulletsRequest"},"deleteComment":{"$ref":"#/components/schemas/docs_v1_DeleteCommentRequest"},"deleteCommentReply":{"$ref":"#/components/schemas/docs_v1_DeleteCommentReplyRequest"},"deleteContentRange":{"$ref":"#/components/schemas/docs_v1_DeleteContentRangeRequest"},"deleteDropdownDefinition":{"$ref":"#/components/schemas/docs_v1_DeleteDropdownDefinitionRequest"},"deleteFooter":{"$ref":"#/components/schemas/docs_v1_DeleteFooterRequest"},"deleteHeader":{"$ref":"#/components/schemas/docs_v1_DeleteHeaderRequest"},"deleteNamedRange":{"$ref":"#/components/schemas/docs_v1_DeleteNamedRangeRequest"},"deleteParagraphBullets":{"$ref":"#/components/schemas/docs_v1_DeleteParagraphBulletsRequest"},"deletePositionedObject":{"$ref":"#/components/schemas/docs_v1_DeletePositionedObjectRequest"},"deleteSuggestion":{"$ref":"#/components/schemas/docs_v1_DeleteSuggestionRequest"},"deleteTab":{"$ref":"#/components/schemas/docs_v1_DeleteTabRequest"},"deleteTableColumn":{"$ref":"#/components/schemas/docs_v1_DeleteTableColumnRequest"},"deleteTableRow":{"$ref":"#/components/schemas/docs_v1_DeleteTableRowRequest"},"insertComment":{"$ref":"#/components/schemas/docs_v1_InsertCommentRequest"},"insertDate":{"$ref":"#/components/schemas/docs_v1_InsertDateRequest"},"insertDropdown":{"$ref":"#/components/schemas/docs_v1_InsertDropdownRequest"},"insertInlineImage":{"$ref":"#/components/schemas/docs_v1_InsertInlineImageRequest"},"insertPageBreak":{"$ref":"#/components/schemas/docs_v1_InsertPageBreakRequest"},"insertPerson":{"$ref":"#/components/schemas/docs_v1_InsertPersonRequest"},"insertRichLink":{"$ref":"#/components/schemas/docs_v1_InsertRichLinkRequest"},"insertSectionBreak":{"$ref":"#/components/schemas/docs_v1_InsertSectionBreakRequest"},"insertTable":{"$ref":"#/components/schemas/docs_v1_InsertTableRequest"},"insertTableColumn":{"$ref":"#/components/schemas/docs_v1_InsertTableColumnRequest"},"insertTableRow":{"$ref":"#/components/schemas/docs_v1_InsertTableRowRequest"},"insertText":{"$ref":"#/components/schemas/docs_v1_InsertTextRequest"},"mergeTableCells":{"$ref":"#/components/schemas/docs_v1_MergeTableCellsRequest"},"pinTableHeaderRows":{"$ref":"#/components/schemas/docs_v1_PinTableHeaderRowsRequest"},"rejectSuggestion":{"$ref":"#/components/schemas/docs_v1_RejectSuggestionRequest"},"replaceAllText":{"$ref":"#/components/schemas/docs_v1_ReplaceAllTextRequest"},"replaceImage":{"$ref":"#/components/schemas/docs_v1_ReplaceImageRequest"},"replaceNamedRangeContent":{"$ref":"#/components/schemas/docs_v1_ReplaceNamedRangeContentRequest"},"unmergeTableCells":{"$ref":"#/components/schemas/docs_v1_UnmergeTableCellsRequest"},"updateCommentPost":{"$ref":"#/components/schemas/docs_v1_UpdateCommentPostRequest"},"updateDocumentStyle":{"$ref":"#/components/schemas/docs_v1_UpdateDocumentStyleRequest"},"updateDocumentTabProperties":{"$ref":"#/components/schemas/docs_v1_UpdateDocumentTabPropertiesRequest"},"updateDropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_UpdateDropdownDefinitionPropertiesRequest"},"updateDropdownProperties":{"$ref":"#/components/schemas/docs_v1_UpdateDropdownPropertiesRequest"},"updateNamedStyle":{"$ref":"#/components/schemas/docs_v1_UpdateNamedStyleRequest"},"updateParagraphStyle":{"$ref":"#/components/schemas/docs_v1_UpdateParagraphStyleRequest"},"updateSectionStyle":{"$ref":"#/components/schemas/docs_v1_UpdateSectionStyleRequest"},"updateTableCellStyle":{"$ref":"#/components/schemas/docs_v1_UpdateTableCellStyleRequest"},"updateTableColumnProperties":{"$ref":"#/components/schemas/docs_v1_UpdateTableColumnPropertiesRequest"},"updateTableRowStyle":{"$ref":"#/components/schemas/docs_v1_UpdateTableRowStyleRequest"},"updateTextStyle":{"$ref":"#/components/schemas/docs_v1_UpdateTextStyleRequest"}}},"docs_v1_Response":{"description":"A single response from an update.","type":"object","properties":{"addCommentReply":{"$ref":"#/components/schemas/docs_v1_AddCommentReplyResponse"},"addDocumentTab":{"$ref":"#/components/schemas/docs_v1_AddDocumentTabResponse"},"createDropdownDefinition":{"$ref":"#/components/schemas/docs_v1_CreateDropdownDefinitionResponse"},"createFooter":{"$ref":"#/components/schemas/docs_v1_CreateFooterResponse"},"createFootnote":{"$ref":"#/components/schemas/docs_v1_CreateFootnoteResponse"},"createHeader":{"$ref":"#/components/schemas/docs_v1_CreateHeaderResponse"},"createNamedRange":{"$ref":"#/components/schemas/docs_v1_CreateNamedRangeResponse"},"insertComment":{"$ref":"#/components/schemas/docs_v1_InsertCommentResponse"},"insertDropdown":{"$ref":"#/components/schemas/docs_v1_InsertDropdownResponse"},"insertInlineImage":{"$ref":"#/components/schemas/docs_v1_InsertInlineImageResponse"},"insertInlineSheetsChart":{"$ref":"#/components/schemas/docs_v1_InsertInlineSheetsChartResponse"},"replaceAllText":{"$ref":"#/components/schemas/docs_v1_ReplaceAllTextResponse"}}},"docs_v1_RgbColor":{"description":"An RGB color.","type":"object","properties":{"blue":{"description":"The blue component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"green":{"description":"The green component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"red":{"description":"The red component of the color, from 0.0 to 1.0.","format":"float","type":"number"}}},"docs_v1_RichLink":{"description":"A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event).","type":"object","properties":{"richLinkId":{"description":"Output only. The ID of this link.","readOnly":true,"type":"string"},"richLinkProperties":{"$ref":"#/components/schemas/docs_v1_RichLinkProperties"},"suggestedDeletionIds":{"description":"IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this RichLink, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_RichLinkProperties":{"description":"Properties specific to a RichLink.","type":"object","properties":{"mimeType":{"description":"The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).","type":"string"},"title":{"description":"The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.","type":"string"},"uri":{"description":"The URI to the RichLink. This is always present.","type":"string"}}},"docs_v1_SectionBreak":{"description":"A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.","type":"object","properties":{"sectionStyle":{"$ref":"#/components/schemas/docs_v1_SectionStyle"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}}}},"docs_v1_SectionColumnProperties":{"description":"Properties that apply to a section's column.","type":"object","properties":{"paddingEnd":{"$ref":"#/components/schemas/docs_v1_Dimension"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_SectionStyle":{"description":"The styling that applies to a section.","type":"object","properties":{"columnProperties":{"description":"The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_SectionColumnProperties"}},"columnSeparatorStyle":{"description":"The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","enum":["COLUMN_SEPARATOR_STYLE_UNSPECIFIED","NONE","BETWEEN_EACH_COLUMN"],"type":"string"},"contentDirection":{"description":"The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","enum":["CONTENT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"defaultFooterId":{"description":"The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"defaultHeaderId":{"description":"The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"evenPageFooterId":{"description":"The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"evenPageHeaderId":{"description":"The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageFooterId":{"description":"The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"firstPageHeaderId":{"description":"The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.","type":"string"},"flipPageOrientation":{"description":"Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","type":"boolean"},"marginBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginFooter":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginHeader":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"marginTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"pageNumberStart":{"description":"The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","format":"int32","type":"integer"},"sectionType":{"description":"Output only. The type of section.","enum":["SECTION_TYPE_UNSPECIFIED","CONTINUOUS","NEXT_PAGE"],"type":"string"},"useFirstPageHeaderFooter":{"description":"Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.","type":"boolean"}}},"docs_v1_Shading":{"description":"The shading of a paragraph.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"}}},"docs_v1_ShadingSuggestionState":{"description":"A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates if there was a suggested change to the Shading.","type":"boolean"}}},"docs_v1_SheetsChartReference":{"description":"A reference to a linked chart embedded from Google Sheets.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet that's embedded.","format":"int32","type":"integer"},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the source chart.","type":"string"}}},"docs_v1_SheetsChartReferenceSuggestionState":{"description":"A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"chartIdSuggested":{"description":"Indicates if there was a suggested change to chart_id.","type":"boolean"},"spreadsheetIdSuggested":{"description":"Indicates if there was a suggested change to spreadsheet_id.","type":"boolean"}}},"docs_v1_Size":{"description":"A width and height.","type":"object","properties":{"height":{"$ref":"#/components/schemas/docs_v1_Dimension"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_SizeSuggestionState":{"description":"A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value.","type":"object","properties":{"heightSuggested":{"description":"Indicates if there was a suggested change to height.","type":"boolean"},"widthSuggested":{"description":"Indicates if there was a suggested change to width.","type":"boolean"}}},"docs_v1_StructuralElement":{"description":"A StructuralElement describes content that provides structure to the document.","type":"object","properties":{"endIndex":{"description":"The zero-based end index of this structural element, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"paragraph":{"$ref":"#/components/schemas/docs_v1_Paragraph"},"sectionBreak":{"$ref":"#/components/schemas/docs_v1_SectionBreak"},"startIndex":{"description":"The zero-based start index of this structural element, in UTF-16 code units.","format":"int32","type":"integer"},"table":{"$ref":"#/components/schemas/docs_v1_Table"},"tableOfContents":{"$ref":"#/components/schemas/docs_v1_TableOfContents"}}},"docs_v1_SubstringMatchCriteria":{"description":"A criteria that matches a specific string of text in the document.","type":"object","properties":{"matchCase":{"description":"Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive.","type":"boolean"},"searchByRegex":{"description":"Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching.","type":"boolean"},"text":{"description":"The text to search for in the document.","type":"string"}}},"docs_v1_SuggestedBullet":{"description":"A suggested change to a Bullet.","type":"object","properties":{"bullet":{"$ref":"#/components/schemas/docs_v1_Bullet"},"bulletSuggestionState":{"$ref":"#/components/schemas/docs_v1_BulletSuggestionState"}}},"docs_v1_SuggestedDateElementProperties":{"description":"A suggested change to a DateElementProperties.","type":"object","properties":{"dateElementProperties":{"$ref":"#/components/schemas/docs_v1_DateElementProperties"},"dateElementPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_DateElementPropertiesSuggestionState"}}},"docs_v1_SuggestedDocumentStyle":{"description":"A suggested change to the DocumentStyle.","type":"object","properties":{"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"documentStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_DocumentStyleSuggestionState"}}},"docs_v1_SuggestedDropdownDefinitionProperties":{"description":"A suggested change to dropdown definition properties.","type":"object","properties":{"dropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionProperties"},"dropdownDefinitionPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionPropertiesSuggestionState"}}},"docs_v1_SuggestedDropdownProperties":{"description":"A suggested change to dropdown properties.","type":"object","properties":{"dropdownProperties":{"$ref":"#/components/schemas/docs_v1_DropdownProperties"},"dropdownPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_DropdownPropertiesSuggestionState"}}},"docs_v1_SuggestedInlineObjectProperties":{"description":"A suggested change to InlineObjectProperties.","type":"object","properties":{"inlineObjectProperties":{"$ref":"#/components/schemas/docs_v1_InlineObjectProperties"},"inlineObjectPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_InlineObjectPropertiesSuggestionState"}}},"docs_v1_SuggestedListProperties":{"description":"A suggested change to ListProperties.","type":"object","properties":{"listProperties":{"$ref":"#/components/schemas/docs_v1_ListProperties"},"listPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_ListPropertiesSuggestionState"}}},"docs_v1_SuggestedNamedStyles":{"description":"A suggested change to the NamedStyles.","type":"object","properties":{"namedStyles":{"$ref":"#/components/schemas/docs_v1_NamedStyles"},"namedStylesSuggestionState":{"$ref":"#/components/schemas/docs_v1_NamedStylesSuggestionState"}}},"docs_v1_SuggestedParagraphStyle":{"description":"A suggested change to a ParagraphStyle.","type":"object","properties":{"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"paragraphStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_ParagraphStyleSuggestionState"}}},"docs_v1_SuggestedPositionedObjectProperties":{"description":"A suggested change to PositionedObjectProperties.","type":"object","properties":{"positionedObjectProperties":{"$ref":"#/components/schemas/docs_v1_PositionedObjectProperties"},"positionedObjectPropertiesSuggestionState":{"$ref":"#/components/schemas/docs_v1_PositionedObjectPropertiesSuggestionState"}}},"docs_v1_SuggestedTableCellStyle":{"description":"A suggested change to a TableCellStyle.","type":"object","properties":{"tableCellStyle":{"$ref":"#/components/schemas/docs_v1_TableCellStyle"},"tableCellStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TableCellStyleSuggestionState"}}},"docs_v1_SuggestedTableRowStyle":{"description":"A suggested change to a TableRowStyle.","type":"object","properties":{"tableRowStyle":{"$ref":"#/components/schemas/docs_v1_TableRowStyle"},"tableRowStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TableRowStyleSuggestionState"}}},"docs_v1_SuggestedTextStyle":{"description":"A suggested change to a TextStyle.","type":"object","properties":{"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"},"textStyleSuggestionState":{"$ref":"#/components/schemas/docs_v1_TextStyleSuggestionState"}}},"docs_v1_SuggestionResponse":{"description":"The suggestions which were affected by a given update. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"acceptedSuggestionIds":{"description":"The IDs of suggestions which were accepted during the update.","type":"array","items":{"type":"string"}},"createdSuggestionIds":{"description":"The IDs of suggestions which were created during the update.","type":"array","items":{"type":"string"}},"deletedSuggestionIds":{"description":"The IDs of suggestions which were deleted during the update.","type":"array","items":{"type":"string"}},"rejectedSuggestionIds":{"description":"The IDs of suggestions which were rejected during the update.","type":"array","items":{"type":"string"}},"updatedSummarySuggestionIds":{"description":"The IDs of suggestions whose summaries were updated during the update.","type":"array","items":{"type":"string"}}}},"docs_v1_SuggestionThread":{"description":"Represents a single suggestion thread. Suggestion threads are created as a byproduct of saving changes to the document while in suggestion mode, and cannot be created directly. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"headPost":{"$ref":"#/components/schemas/docs_v1_Post"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Post"}},"status":{"description":"Whether the thread is open, accepted, or rejected.","enum":["STATUS_UNSPECIFIED","OPEN","ACCEPTED","REJECTED"],"type":"string"},"suggestionId":{"description":"The unique ID of the suggestion.","type":"string"},"summaryHtml":{"description":"Summary of the suggested differences in the document, in HTML. May be empty.","type":"string"},"summaryText":{"description":"Summary of the suggested differences in the document, in plain text. May be empty.","type":"string"}}},"docs_v1_Tab":{"description":"A tab in a document.","type":"object","properties":{"childTabs":{"description":"The child tabs nested within this tab.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_Tab"}},"documentTab":{"$ref":"#/components/schemas/docs_v1_DocumentTab"},"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_TabProperties":{"description":"Properties of a tab.","type":"object","properties":{"iconEmoji":{"description":"Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value is unset or empty, the tab will display the default tab icon.","type":"string"},"index":{"description":"The zero-based index of the tab within the parent.","format":"int32","type":"integer"},"nestingLevel":{"description":"Output only. The depth of the tab within the document. Root-level tabs start at 0.","format":"int32","type":"integer"},"parentTabId":{"description":"Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.","type":"string"},"tabId":{"description":"The immutable ID of the tab.","type":"string"},"title":{"description":"The user-visible name of the tab.","type":"string"}}},"docs_v1_TabStop":{"description":"A tab stop within a paragraph.","type":"object","properties":{"alignment":{"description":"The alignment of this tab stop. If unset, the value defaults to START.","enum":["TAB_STOP_ALIGNMENT_UNSPECIFIED","START","CENTER","END"],"type":"string"},"offset":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_Table":{"description":"A StructuralElement representing a table.","type":"object","properties":{"columns":{"description":"Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.","format":"int32","type":"integer"},"rows":{"description":"Number of rows in the table.","format":"int32","type":"integer"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"tableRows":{"description":"The contents and style of each row.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TableRow"}},"tableStyle":{"$ref":"#/components/schemas/docs_v1_TableStyle"}}},"docs_v1_TableCell":{"description":"The contents and style of a cell in a Table.","type":"object","properties":{"content":{"description":"The content of the cell.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"endIndex":{"description":"The zero-based end index of this cell, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"startIndex":{"description":"The zero-based start index of this cell, in UTF-16 code units.","format":"int32","type":"integer"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTableCellStyleChanges":{"description":"The suggested changes to the table cell style, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTableCellStyle"}},"tableCellStyle":{"$ref":"#/components/schemas/docs_v1_TableCellStyle"}}},"docs_v1_TableCellBorder":{"description":"A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0.","type":"object","properties":{"color":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH"],"type":"string"},"width":{"$ref":"#/components/schemas/docs_v1_Dimension"}}},"docs_v1_TableCellLocation":{"description":"Location of a single cell within a table.","type":"object","properties":{"columnIndex":{"description":"The zero-based column index. For example, the second column in the table has a column index of 1.","format":"int32","type":"integer"},"rowIndex":{"description":"The zero-based row index. For example, the second row in the table has a row index of 1.","format":"int32","type":"integer"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_TableCellStyle":{"description":"The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"borderBottom":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"borderLeft":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"borderRight":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"borderTop":{"$ref":"#/components/schemas/docs_v1_TableCellBorder"},"columnSpan":{"description":"The column span of the cell. This property is read-only.","format":"int32","type":"integer"},"contentAlignment":{"description":"The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.","enum":["CONTENT_ALIGNMENT_UNSPECIFIED","CONTENT_ALIGNMENT_UNSUPPORTED","TOP","MIDDLE","BOTTOM"],"type":"string"},"paddingBottom":{"$ref":"#/components/schemas/docs_v1_Dimension"},"paddingLeft":{"$ref":"#/components/schemas/docs_v1_Dimension"},"paddingRight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"paddingTop":{"$ref":"#/components/schemas/docs_v1_Dimension"},"rowSpan":{"description":"The row span of the cell. This property is read-only.","format":"int32","type":"integer"}}},"docs_v1_TableCellStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates if there was a suggested change to background_color.","type":"boolean"},"borderBottomSuggested":{"description":"Indicates if there was a suggested change to border_bottom.","type":"boolean"},"borderLeftSuggested":{"description":"Indicates if there was a suggested change to border_left.","type":"boolean"},"borderRightSuggested":{"description":"Indicates if there was a suggested change to border_right.","type":"boolean"},"borderTopSuggested":{"description":"Indicates if there was a suggested change to border_top.","type":"boolean"},"columnSpanSuggested":{"description":"Indicates if there was a suggested change to column_span.","type":"boolean"},"contentAlignmentSuggested":{"description":"Indicates if there was a suggested change to content_alignment.","type":"boolean"},"paddingBottomSuggested":{"description":"Indicates if there was a suggested change to padding_bottom.","type":"boolean"},"paddingLeftSuggested":{"description":"Indicates if there was a suggested change to padding_left.","type":"boolean"},"paddingRightSuggested":{"description":"Indicates if there was a suggested change to padding_right.","type":"boolean"},"paddingTopSuggested":{"description":"Indicates if there was a suggested change to padding_top.","type":"boolean"},"rowSpanSuggested":{"description":"Indicates if there was a suggested change to row_span.","type":"boolean"}}},"docs_v1_TableColumnProperties":{"description":"The properties of a column in a table.","type":"object","properties":{"width":{"$ref":"#/components/schemas/docs_v1_Dimension"},"widthType":{"description":"The width type of the column.","enum":["WIDTH_TYPE_UNSPECIFIED","EVENLY_DISTRIBUTED","FIXED_WIDTH"],"type":"string"}}},"docs_v1_TableOfContents":{"description":"A StructuralElement representing a table of contents.","type":"object","properties":{"content":{"description":"The content of the table of contents.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_StructuralElement"}},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}}}},"docs_v1_TableRange":{"description":"A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with table cell location = (table_start_location, row = 0, column = 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]","type":"object","properties":{"columnSpan":{"description":"The column span of the table range.","format":"int32","type":"integer"},"rowSpan":{"description":"The row span of the table range.","format":"int32","type":"integer"},"tableCellLocation":{"$ref":"#/components/schemas/docs_v1_TableCellLocation"}}},"docs_v1_TableRow":{"description":"The contents and style of a row in a Table.","type":"object","properties":{"endIndex":{"description":"The zero-based end index of this row, exclusive, in UTF-16 code units.","format":"int32","type":"integer"},"startIndex":{"description":"The zero-based start index of this row, in UTF-16 code units.","format":"int32","type":"integer"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTableRowStyleChanges":{"description":"The suggested style changes to this row, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTableRowStyle"}},"tableCells":{"description":"The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TableCell"}},"tableRowStyle":{"$ref":"#/components/schemas/docs_v1_TableRowStyle"}}},"docs_v1_TableRowStyle":{"description":"Styles that apply to a table row.","type":"object","properties":{"minRowHeight":{"$ref":"#/components/schemas/docs_v1_Dimension"},"preventOverflow":{"description":"Whether the row cannot overflow across page or column boundaries.","type":"boolean"},"tableHeader":{"description":"Whether the row is a table header.","type":"boolean"}}},"docs_v1_TableRowStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"minRowHeightSuggested":{"description":"Indicates if there was a suggested change to min_row_height.","type":"boolean"}}},"docs_v1_TableStyle":{"description":"Styles that apply to a table.","type":"object","properties":{"tableColumnProperties":{"description":"The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.","type":"array","items":{"$ref":"#/components/schemas/docs_v1_TableColumnProperties"}}}},"docs_v1_TabsCriteria":{"description":"A criteria that specifies in which tabs a request executes.","type":"object","properties":{"tabIds":{"description":"The list of tab IDs in which the request executes.","type":"array","items":{"type":"string"}}}},"docs_v1_TextRun":{"description":"A ParagraphElement that represents a run of text that all has the same styling.","type":"object","properties":{"content":{"description":"The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.","type":"string"},"suggestedDeletionIds":{"description":"The suggested deletion IDs. If empty, then there are no suggested deletions of this content.","type":"array","items":{"type":"string"}},"suggestedInsertionIds":{"description":"The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.","type":"array","items":{"type":"string"}},"suggestedTextStyleChanges":{"description":"The suggested text style changes to this run, keyed by suggestion ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/docs_v1_SuggestedTextStyle"}},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_TextStyle":{"description":"Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"baselineOffset":{"description":"The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.","enum":["BASELINE_OFFSET_UNSPECIFIED","NONE","SUPERSCRIPT","SUBSCRIPT"],"type":"string"},"bold":{"description":"Whether or not the text is rendered as bold.","type":"boolean"},"fontSize":{"$ref":"#/components/schemas/docs_v1_Dimension"},"foregroundColor":{"$ref":"#/components/schemas/docs_v1_OptionalColor"},"italic":{"description":"Whether or not the text is italicized.","type":"boolean"},"link":{"$ref":"#/components/schemas/docs_v1_Link"},"smallCaps":{"description":"Whether or not the text is in small capital letters.","type":"boolean"},"strikethrough":{"description":"Whether or not the text is struck through.","type":"boolean"},"underline":{"description":"Whether or not the text is underlined.","type":"boolean"},"weightedFontFamily":{"$ref":"#/components/schemas/docs_v1_WeightedFontFamily"}}},"docs_v1_TextStyleSuggestionState":{"description":"A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.","type":"object","properties":{"backgroundColorSuggested":{"description":"Indicates if there was a suggested change to background_color.","type":"boolean"},"baselineOffsetSuggested":{"description":"Indicates if there was a suggested change to baseline_offset.","type":"boolean"},"boldSuggested":{"description":"Indicates if there was a suggested change to bold.","type":"boolean"},"fontSizeSuggested":{"description":"Indicates if there was a suggested change to font_size.","type":"boolean"},"foregroundColorSuggested":{"description":"Indicates if there was a suggested change to foreground_color.","type":"boolean"},"italicSuggested":{"description":"Indicates if there was a suggested change to italic.","type":"boolean"},"linkSuggested":{"description":"Indicates if there was a suggested change to link.","type":"boolean"},"smallCapsSuggested":{"description":"Indicates if there was a suggested change to small_caps.","type":"boolean"},"strikethroughSuggested":{"description":"Indicates if there was a suggested change to strikethrough.","type":"boolean"},"underlineSuggested":{"description":"Indicates if there was a suggested change to underline.","type":"boolean"},"weightedFontFamilySuggested":{"description":"Indicates if there was a suggested change to weighted_font_family.","type":"boolean"}}},"docs_v1_UnmergeTableCellsRequest":{"description":"Unmerges cells in a Table.","type":"object","properties":{"tableRange":{"$ref":"#/components/schemas/docs_v1_TableRange"}}},"docs_v1_UpdateCommentPostRequest":{"description":"Updates a Post in a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The post is the headPost of a SuggestionThread. - The requesting user is not the author of the post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"content":{"description":"The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"postId":{"description":"The ID of the post being updated.","type":"string"},"suggestionId":{"description":"The ID of the SuggestionThread which the post belongs to.","type":"string"}}},"docs_v1_UpdateDocumentStyleRequest":{"description":"Updates the DocumentStyle.","type":"object","properties":{"documentStyle":{"$ref":"#/components/schemas/docs_v1_DocumentStyle"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `\"background\"`.","format":"google-fieldmask","type":"string"},"tabId":{"description":"The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_UpdateDocumentTabPropertiesRequest":{"description":"Update the properties of a document tab.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tab_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"tabProperties":{"$ref":"#/components/schemas/docs_v1_TabProperties"}}},"docs_v1_UpdateDropdownDefinitionPropertiesRequest":{"description":"Updates the properties of a DropdownDefinition.","type":"object","properties":{"dropdownDefinitionId":{"description":"The ID of the DropdownDefinition to update.","type":"string"},"dropdownDefinitionProperties":{"$ref":"#/components/schemas/docs_v1_DropdownDefinitionProperties"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`.","format":"google-fieldmask","type":"string"},"selectedOptionIdReplacements":{"description":"A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{\"A\": \"B\"}`.","type":"object","additionalProperties":{"type":"string"}},"tabId":{"description":"The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_UpdateDropdownPropertiesRequest":{"description":"Updates the properties of a Dropdown.","type":"object","properties":{"dropdownId":{"description":"Required. The Dropdown ID.","type":"string"},"dropdownProperties":{"$ref":"#/components/schemas/docs_v1_DropdownProperties"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dropdown_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"tabId":{"description":"The ID of the tab that contains the dropdown to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.","type":"string"}}},"docs_v1_UpdateNamedStyleRequest":{"description":"Updates a named style.","type":"object","properties":{"fields":{"description":"The NamedStyle fields that should be updated. At least `named_style_type` must be specified. The root `named_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `\"text_style\"` and `\"text_style.bold\"`. To update the paragraph style's alignment property, set `fields` to include `\"paragraph_style\"` and `\"paragraph_style.alignment\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `\"text_style\"` or `\"paragraph_style\"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields.","format":"google-fieldmask","type":"string"},"namedStyle":{"$ref":"#/components/schemas/docs_v1_NamedStyle"},"tabId":{"description":"The document tab to update. By default, the update is applied to the first tab.","type":"string"}}},"docs_v1_UpdateParagraphStyleRequest":{"description":"Update the styling of all paragraphs that overlap with the given range.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set `fields` to `\"alignment\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"paragraphStyle":{"$ref":"#/components/schemas/docs_v1_ParagraphStyle"},"range":{"$ref":"#/components/schemas/docs_v1_Range"}}},"docs_v1_UpdateSectionStyleRequest":{"description":"Updates the SectionStyle.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `section_style` is implied and must not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the left margin, set `fields` to `\"margin_left\"`.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"},"sectionStyle":{"$ref":"#/components/schemas/docs_v1_SectionStyle"}}},"docs_v1_UpdateTableCellStyleRequest":{"description":"Updates the style of a range of table cells.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableCellStyle` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the table cell background color, set `fields` to `\"backgroundColor\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"tableCellStyle":{"$ref":"#/components/schemas/docs_v1_TableCellStyle"},"tableRange":{"$ref":"#/components/schemas/docs_v1_TableRange"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_UpdateTableColumnPropertiesRequest":{"description":"Updates the TableColumnProperties of columns in a table.","type":"object","properties":{"columnIndices":{"description":"The list of zero-based column indices whose property should be updated. If no indices are specified, all columns will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `\"width\"`.","format":"google-fieldmask","type":"string"},"tableColumnProperties":{"$ref":"#/components/schemas/docs_v1_TableColumnProperties"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_UpdateTableRowStyleRequest":{"description":"Updates the TableRowStyle of rows in a table.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableRowStyle` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `\"min_row_height\"`.","format":"google-fieldmask","type":"string"},"rowIndices":{"description":"The list of zero-based row indices whose style should be updated. If no indices are specified, all rows will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"tableRowStyle":{"$ref":"#/components/schemas/docs_v1_TableRowStyle"},"tableStartLocation":{"$ref":"#/components/schemas/docs_v1_Location"}}},"docs_v1_UpdateTextStyleRequest":{"description":"Update the styling of text.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `text_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `\"bold\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/docs_v1_Range"},"textStyle":{"$ref":"#/components/schemas/docs_v1_TextStyle"}}},"docs_v1_WeightedFontFamily":{"description":"Represents a font family and weight of text.","type":"object","properties":{"fontFamily":{"description":"The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.","type":"string"},"weight":{"description":"The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` (\"normal\"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.","format":"int32","type":"integer"}}},"docs_v1_WriteControl":{"description":"Provides control over how write requests are executed.","type":"object","properties":{"requiredRevisionId":{"description":"The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.","type":"string"},"targetRevisionId":{"description":"The optional target revision ID of the document the write request is applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request are applied against the collaborator changes. This results in a new revision of the document that incorporates both the collaborator changes and the changes in the request, with the Docs server resolving conflicting changes. When using target revision ID, the API client can be thought of as another collaborator of the document. The target revision ID can only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 bad request error. The request should be tried again after retrieving the latest version of the document. Usually a revision ID remains valid for use as a target revision for several minutes after it's read, but for frequently edited documents this window might be shorter.","type":"string"},"writeMode":{"description":"How the request updates should be applied to the document. If unspecified, the request updates will be applied as normal edits. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["WRITE_MODE_UNSPECIFIED","EDIT","SUGGEST"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/documents":"See, edit, create, and delete all your Google Docs documents","https://www.googleapis.com/auth/documents.readonly":"See all your Google Docs documents"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/documents"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/docs/v1/rest","service":"docs","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-drive.json b/public/specs/google/google-drive.json index 68bbe15f..29312886 100644 --- a/public/specs/google/google-drive.json +++ b/public/specs/google/google-drive.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Drive API","version":"v3","description":"The Google Drive API allows clients to access resources from Google Drive."},"servers":[{"url":"https://www.googleapis.com/drive/v3/"}],"paths":{"/about":{"get":{"operationId":"drive.about.get","x-executor-toolPath":"drive.about.get","tags":["Google Drive API"],"description":"Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_About"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/apps/{appId}":{"get":{"operationId":"drive.apps.get","x-executor-toolPath":"drive.apps.get","tags":["Google Drive API"],"description":"Gets a specific app. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info).","parameters":[{"name":"appId","in":"path","required":true,"description":"The ID of the app.","schema":{"description":"The ID of the app.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_App"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/changes":{"get":{"operationId":"drive.changes.list","x-executor-toolPath":"drive.changes.list","tags":["Google Drive API"],"description":"Lists the changes for a user or shared drive. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","schema":{"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeCorpusRemovals","in":"query","required":false,"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","schema":{"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeItemsFromAllDrives","in":"query","required":false,"description":"Whether both My Drive and shared drive items should be included in results.","schema":{"description":"Whether both My Drive and shared drive items should be included in results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","type":"string"},"style":"form","explode":false},{"name":"includeRemoved","in":"query","required":false,"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","schema":{"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"includeTeamDriveItems","in":"query","required":false,"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","schema":{"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":true,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"restrictToMyDrive","in":"query","required":false,"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","schema":{"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"spaces","in":"query","required":false,"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","schema":{"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","default":"drive","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ChangeList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/changes/startPageToken":{"get":{"operationId":"drive.changes.getStartPageToken","x-executor-toolPath":"drive.changes.getStartPageToken","tags":["Google Drive API"],"description":"Gets the starting pageToken for listing future changes. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.","schema":{"description":"The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_StartPageToken"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/changes/watch":{"post":{"operationId":"drive.changes.watch","x-executor-toolPath":"drive.changes.watch","tags":["Google Drive API"],"description":"Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","schema":{"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeCorpusRemovals","in":"query","required":false,"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","schema":{"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeItemsFromAllDrives","in":"query","required":false,"description":"Whether both My Drive and shared drive items should be included in results.","schema":{"description":"Whether both My Drive and shared drive items should be included in results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","type":"string"},"style":"form","explode":false},{"name":"includeRemoved","in":"query","required":false,"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","schema":{"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"includeTeamDriveItems","in":"query","required":false,"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","schema":{"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":true,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"restrictToMyDrive","in":"query","required":false,"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","schema":{"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"spaces","in":"query","required":false,"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","schema":{"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","default":"drive","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/channels/stop":{"post":{"operationId":"drive.channels.stop","x-executor-toolPath":"drive.channels.stop","tags":["Google Drive API"],"description":"Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/drives":{"get":{"operationId":"drive.drives.list","x-executor-toolPath":"drive.drives.list","tags":["Google Drive API"],"description":"Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](https://developers.google.com/workspace/drive/api/guides/search-shareddrives) guide.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","default":10,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token for shared drives.","schema":{"description":"Page token for shared drives.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Query string for searching shared drives.","schema":{"description":"Query string for searching shared drives.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.","schema":{"description":"Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_DriveList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.drives.create","x-executor-toolPath":"drive.drives.create","tags":["Google Drive API"],"description":"Creates a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":true,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.","schema":{"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/drives/{driveId}":{"get":{"operationId":"drive.drives.get","x-executor-toolPath":"drive.drives.get","tags":["Google Drive API"],"description":"Gets a shared drive's metadata by ID. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.drives.delete","x-executor-toolPath":"drive.drives.delete","tags":["Google Drive API"],"description":"Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allowItemDeletion","in":"query","required":false,"description":"Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.","schema":{"description":"Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.drives.update","x-executor-toolPath":"drive.drives.update","tags":["Google Drive API"],"description":"Updates the metadata for a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/drives/{driveId}/hide":{"post":{"operationId":"drive.drives.hide","x-executor-toolPath":"drive.drives.hide","tags":["Google Drive API"],"description":"Hides a shared drive from the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/drives/{driveId}/unhide":{"post":{"operationId":"drive.drives.unhide","x-executor-toolPath":"drive.drives.unhide","tags":["Google Drive API"],"description":"Restores a shared drive to the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files":{"get":{"operationId":"drive.files.list","x-executor-toolPath":"drive.files.list","tags":["Google Drive API"],"description":"Lists the user's files. For more information, see [Search for files and folders](https://developers.google.com/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"corpora","in":"query","required":false,"description":"Specifies a collection of items (files or documents) to which the query applies. Supported items include: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"Specifies a collection of items (files or documents) to which the query applies. Supported items include: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","type":"string"},"style":"form","explode":false},{"name":"corpus","in":"query","required":false,"description":"Deprecated: The source of files to list. Use `corpora` instead.","schema":{"description":"Deprecated: The source of files to list. Use `corpora` instead.","enum":["domain","user"],"type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"ID of the shared drive to search.","schema":{"description":"ID of the shared drive to search.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeItemsFromAllDrives","in":"query","required":false,"description":"Whether both My Drive and shared drive items should be included in results.","schema":{"description":"Whether both My Drive and shared drive items should be included in results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"includeTeamDriveItems","in":"query","required":false,"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","schema":{"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use `modifiedTime desc` instead. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.","schema":{"description":"A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use `modifiedTime desc` instead. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).","schema":{"description":"A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"spaces","in":"query","required":false,"description":"A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","default":"drive","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_FileList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.files.create","x-executor-toolPath":"drive.files.create","tags":["Google Drive API"],"description":"Creates a file. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Creating files in multiple folders is no longer supported.","schema":{"description":"Deprecated: Creating files in multiple folders is no longer supported.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"ignoreDefaultVisibility","in":"query","required":false,"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","schema":{"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/generateCseToken":{"get":{"operationId":"drive.files.generateCseToken","x-executor-toolPath":"drive.files.generateCseToken","tags":["Google Drive API"],"description":"Generates a CSE token which can be used to create or update CSE files.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"fileId","in":"query","required":false,"description":"The ID of the file for which the JWT should be generated. If not provided, an id will be generated.","schema":{"description":"The ID of the file for which the JWT should be generated. If not provided, an id will be generated.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.","schema":{"description":"The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_GenerateCseTokenResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/generateIds":{"get":{"operationId":"drive.files.generateIds","x-executor-toolPath":"drive.files.generateIds","tags":["Google Drive API"],"description":"Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"count","in":"query","required":false,"description":"The number of IDs to return.","schema":{"description":"The number of IDs to return.","format":"int32","default":10,"type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"space","in":"query","required":false,"description":"The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","default":"drive","type":"string"},"style":"form","explode":false},{"name":"type","in":"query","required":false,"description":"The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","default":"files","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_GeneratedIds"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/trash":{"delete":{"operationId":"drive.files.emptyTrash","x-executor-toolPath":"drive.files.emptyTrash","tags":["Google Drive API"],"description":"Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"If set, empties the trash of the provided shared drive.","schema":{"description":"If set, empties the trash of the provided shared drive.","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","schema":{"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}":{"get":{"operationId":"drive.files.get","x-executor-toolPath":"drive.files.get","tags":["Google Drive API"],"description":"Gets a file's metadata or content by ID. For more information, see [Search for files and folders](https://developers.google.com/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](https://developers.google.com/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"acknowledgeAbuse","in":"query","required":false,"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","schema":{"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.files.delete","x-executor-toolPath":"drive.files.delete","tags":["Google Drive API"],"description":"Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","schema":{"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.files.update","x-executor-toolPath":"drive.files.update","tags":["Google Drive API"],"description":"Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"addParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to add.","schema":{"description":"A comma-separated list of parent IDs to add.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","schema":{"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"removeParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to remove.","schema":{"description":"A comma-separated list of parent IDs to remove.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/accessproposals":{"get":{"operationId":"drive.accessproposals.list","x-executor-toolPath":"drive.accessproposals.list","tags":["Google Drive API"],"description":"List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the item the request is on.","schema":{"description":"Required. The ID of the item the request is on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of results per page.","schema":{"description":"Optional. The number of results per page.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. The continuation token on the list of access requests.","schema":{"description":"Optional. The continuation token on the list of access requests.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ListAccessProposalsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/accessproposals/{proposalId}":{"get":{"operationId":"drive.accessproposals.get","x-executor-toolPath":"drive.accessproposals.get","tags":["Google Drive API"],"description":"Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the item the request is on.","schema":{"description":"Required. The ID of the item the request is on.","type":"string"}},{"name":"proposalId","in":"path","required":true,"description":"Required. The ID of the access proposal to resolve.","schema":{"description":"Required. The ID of the access proposal to resolve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_AccessProposal"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/accessproposals/{proposalId}:resolve":{"post":{"operationId":"drive.accessproposals.resolve","x-executor-toolPath":"drive.accessproposals.resolve","tags":["Google Drive API"],"description":"Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the item the request is on.","schema":{"description":"Required. The ID of the item the request is on.","type":"string"}},{"name":"proposalId","in":"path","required":true,"description":"Required. The ID of the access proposal to resolve.","schema":{"description":"Required. The ID of the access proposal to resolve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ResolveAccessProposalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals":{"get":{"operationId":"drive.approvals.list","x-executor-toolPath":"drive.approvals.list","tags":["Google Drive API"],"description":"Lists the approvals on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). By default, this method returns a minimal response that may not include the items array. To retrieve approval details, you must explicitly specify the fields you want using the `fields` query parameter. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of approvals to return. When not set, at most 100 approvals are returned.","schema":{"description":"The maximum number of approvals to return. When not set, at most 100 approvals are returned.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ApprovalList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}":{"get":{"operationId":"drive.approvals.get","x-executor-toolPath":"drive.approvals.get","tags":["Google Drive API"],"description":"Gets an approval by ID. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval.","schema":{"description":"Required. The ID of the approval.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:approve":{"post":{"operationId":"drive.approvals.approve","x-executor-toolPath":"drive.approvals.approve","tags":["Google Drive API"],"description":"Approves an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `APPROVED`. If this is the last required reviewer response, this also completes the approval and sets the approval Status to `APPROVED`.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to approve.","schema":{"description":"Required. The ID of the approval to approve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ApproveApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:cancel":{"post":{"operationId":"drive.approvals.cancel","x-executor-toolPath":"drive.approvals.cancel","tags":["Google Drive API"],"description":"Cancels an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Updates the approval Status to `CANCELLED`. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS`.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to cancel.","schema":{"description":"Required. The ID of the approval to cancel.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_CancelApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:comment":{"post":{"operationId":"drive.approvals.comment","x-executor-toolPath":"drive.approvals.comment","tags":["Google Drive API"],"description":"Comments on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to comment on.","schema":{"description":"Required. The ID of the approval to comment on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_CommentApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:decline":{"post":{"operationId":"drive.approvals.decline","x-executor-toolPath":"drive.approvals.decline","tags":["Google Drive API"],"description":"Declines an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `DECLINED`. This also completes the approval and sets the approval Status to `DECLINED`.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to decline.","schema":{"description":"Required. The ID of the approval to decline.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_DeclineApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:reassign":{"post":{"operationId":"drive.approvals.reassign","x-executor-toolPath":"drive.approvals.reassign","tags":["Google Drive API"],"description":"Reassigns the reviewers on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS` and the Response for the reviewer being reassigned is `NO_RESPONSE`. A user with the `reader` permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to reassign.","schema":{"description":"Required. The ID of the approval to reassign.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ReassignApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals:start":{"post":{"operationId":"drive.approvals.start","x-executor-toolPath":"drive.approvals.start","tags":["Google Drive API"],"description":"Starts an approval on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is created on.","schema":{"description":"Required. The ID of the file that the approval is created on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_StartApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments":{"get":{"operationId":"drive.comments.list","x-executor-toolPath":"drive.comments.list","tags":["Google Drive API"],"description":"Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to include deleted comments. Deleted comments will not include their original content.","schema":{"description":"Whether to include deleted comments. Deleted comments will not include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startModifiedTime","in":"query","required":false,"description":"The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).","schema":{"description":"The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_CommentList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.comments.create","x-executor-toolPath":"drive.comments.create","tags":["Google Drive API"],"description":"Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments/{commentId}":{"get":{"operationId":"drive.comments.get","x-executor-toolPath":"drive.comments.get","tags":["Google Drive API"],"description":"Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to return deleted comments. Deleted comments will not include their original content.","schema":{"description":"Whether to return deleted comments. Deleted comments will not include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.comments.delete","x-executor-toolPath":"drive.comments.delete","tags":["Google Drive API"],"description":"Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.comments.update","x-executor-toolPath":"drive.comments.update","tags":["Google Drive API"],"description":"Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments/{commentId}/replies":{"get":{"operationId":"drive.replies.list","x-executor-toolPath":"drive.replies.list","tags":["Google Drive API"],"description":"Lists a comment's replies. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to include deleted replies. Deleted replies don't include their original content.","schema":{"description":"Whether to include deleted replies. Deleted replies don't include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ReplyList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.replies.create","x-executor-toolPath":"drive.replies.create","tags":["Google Drive API"],"description":"Creates a reply to a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments/{commentId}/replies/{replyId}":{"get":{"operationId":"drive.replies.get","x-executor-toolPath":"drive.replies.get","tags":["Google Drive API"],"description":"Gets a reply by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"replyId","in":"path","required":true,"description":"The ID of the reply.","schema":{"description":"The ID of the reply.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to return deleted replies. Deleted replies don't include their original content.","schema":{"description":"Whether to return deleted replies. Deleted replies don't include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.replies.delete","x-executor-toolPath":"drive.replies.delete","tags":["Google Drive API"],"description":"Deletes a reply. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"replyId","in":"path","required":true,"description":"The ID of the reply.","schema":{"description":"The ID of the reply.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.replies.update","x-executor-toolPath":"drive.replies.update","tags":["Google Drive API"],"description":"Updates a reply with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"replyId","in":"path","required":true,"description":"The ID of the reply.","schema":{"description":"The ID of the reply.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/copy":{"post":{"operationId":"drive.files.copy","x-executor-toolPath":"drive.files.copy","tags":["Google Drive API"],"description":"Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"copyComments","in":"query","required":false,"description":"Whether to copy the open (unresolved) comments associated with the file.","schema":{"description":"Whether to copy the open (unresolved) comments associated with the file.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.","schema":{"description":"Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"ignoreDefaultVisibility","in":"query","required":false,"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","schema":{"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/download":{"post":{"operationId":"drive.files.download","x-executor-toolPath":"drive.files.download","tags":["Google Drive API"],"description":"Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file to download.","schema":{"description":"Required. The ID of the file to download.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mimeType","in":"query","required":false,"description":"Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.","schema":{"description":"Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"revisionId","in":"query","required":false,"description":"Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.","schema":{"description":"Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/export":{"get":{"operationId":"drive.files.export","x-executor-toolPath":"drive.files.export","tags":["Google Drive API"],"description":"Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mimeType","in":"query","required":true,"description":"Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).","schema":{"description":"Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/listLabels":{"get":{"operationId":"drive.files.listLabels","x-executor-toolPath":"drive.files.listLabels","tags":["Google Drive API"],"description":"Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID for the file.","schema":{"description":"The ID for the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of labels to return per page. When not set, defaults to 100.","schema":{"description":"The maximum number of labels to return per page. When not set, defaults to 100.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_LabelList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/modifyLabels":{"post":{"operationId":"drive.files.modifyLabels","x-executor-toolPath":"drive.files.modifyLabels","tags":["Google Drive API"],"description":"Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file to which the labels belong.","schema":{"description":"The ID of the file to which the labels belong.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ModifyLabelsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ModifyLabelsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/permissions":{"get":{"operationId":"drive.permissions.list","x-executor-toolPath":"drive.permissions.list","tags":["Google Drive API"],"description":"Lists a file's or shared drive's permissions. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_PermissionList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.permissions.create","x-executor-toolPath":"drive.permissions.create","tags":["Google Drive API"],"description":"Creates a permission for a file or shared drive. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"emailMessage","in":"query","required":false,"description":"A plain text custom message to include in the notification email.","schema":{"description":"A plain text custom message to include in the notification email.","type":"string"},"style":"form","explode":false},{"name":"enforceExpansiveAccess","in":"query","required":false,"description":"Deprecated: All requests use the expansive access rules.","schema":{"description":"Deprecated: All requests use the expansive access rules.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: See `moveToNewOwnersRoot` for details.","schema":{"description":"Deprecated: See `moveToNewOwnersRoot` for details.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"moveToNewOwnersRoot","in":"query","required":false,"description":"This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed.","schema":{"description":"This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sendNotificationEmail","in":"query","required":false,"description":"Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.","schema":{"description":"Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.","type":"boolean"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"transferOwnership","in":"query","required":false,"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file).","schema":{"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file).","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/permissions/{permissionId}":{"get":{"operationId":"drive.permissions.get","x-executor-toolPath":"drive.permissions.get","tags":["Google Drive API"],"description":"Gets a permission by ID. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"permissionId","in":"path","required":true,"description":"The ID of the permission.","schema":{"description":"The ID of the permission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.permissions.delete","x-executor-toolPath":"drive.permissions.delete","tags":["Google Drive API"],"description":"Deletes a permission. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"permissionId","in":"path","required":true,"description":"The ID of the permission.","schema":{"description":"The ID of the permission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceExpansiveAccess","in":"query","required":false,"description":"Deprecated: All requests use the expansive access rules.","schema":{"description":"Deprecated: All requests use the expansive access rules.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.permissions.update","x-executor-toolPath":"drive.permissions.update","tags":["Google Drive API"],"description":"Updates a permission with patch semantics. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"permissionId","in":"path","required":true,"description":"The ID of the permission.","schema":{"description":"The ID of the permission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceExpansiveAccess","in":"query","required":false,"description":"Deprecated: All requests use the expansive access rules.","schema":{"description":"Deprecated: All requests use the expansive access rules.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"removeExpiration","in":"query","required":false,"description":"Whether to remove the expiration date.","schema":{"description":"Whether to remove the expiration date.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"transferOwnership","in":"query","required":false,"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com//workspace/drive/api/guides/transfer-file).","schema":{"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com//workspace/drive/api/guides/transfer-file).","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/revisions":{"get":{"operationId":"drive.revisions.list","x-executor-toolPath":"drive.revisions.list","tags":["Google Drive API"],"description":"Lists a file's revisions. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions). **Important:** The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":200,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_RevisionList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/revisions/{revisionId}":{"get":{"operationId":"drive.revisions.get","x-executor-toolPath":"drive.revisions.get","tags":["Google Drive API"],"description":"Gets a revision's metadata or content by ID. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"revisionId","in":"path","required":true,"description":"The ID of the revision.","schema":{"description":"The ID of the revision.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"acknowledgeAbuse","in":"query","required":false,"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","schema":{"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Revision"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.revisions.delete","x-executor-toolPath":"drive.revisions.delete","tags":["Google Drive API"],"description":"Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see [Manage file revisions](https://developers.google.com/drive/api/guides/manage-revisions).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"revisionId","in":"path","required":true,"description":"The ID of the revision.","schema":{"description":"The ID of the revision.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.revisions.update","x-executor-toolPath":"drive.revisions.update","tags":["Google Drive API"],"description":"Updates a revision with patch semantics. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"revisionId","in":"path","required":true,"description":"The ID of the revision.","schema":{"description":"The ID of the revision.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Revision"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Revision"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/watch":{"post":{"operationId":"drive.files.watch","x-executor-toolPath":"drive.files.watch","tags":["Google Drive API"],"description":"Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"acknowledgeAbuse","in":"query","required":false,"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","schema":{"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/operations/{name}":{"get":{"operationId":"drive.operations.get","x-executor-toolPath":"drive.operations.get","tags":["Google Drive API"],"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","parameters":[{"name":"name","in":"path","required":true,"description":"The name of the operation resource.","schema":{"description":"The name of the operation resource.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/teamdrives":{"get":{"operationId":"drive.teamdrives.list","x-executor-toolPath":"drive.teamdrives.list","tags":["Google Drive API"],"description":"Deprecated: Use `drives.list` instead.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of Team Drives to return.","schema":{"description":"Maximum number of Team Drives to return.","format":"int32","default":10,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token for Team Drives.","schema":{"description":"Page token for Team Drives.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Query string for searching Team Drives.","schema":{"description":"Query string for searching Team Drives.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.","schema":{"description":"Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDriveList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.teamdrives.create","x-executor-toolPath":"drive.teamdrives.create","tags":["Google Drive API"],"description":"Deprecated: Use `drives.create` instead.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":true,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.","schema":{"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/teamdrives/{teamDriveId}":{"get":{"operationId":"drive.teamdrives.get","x-executor-toolPath":"drive.teamdrives.get","tags":["Google Drive API"],"description":"Deprecated: Use `drives.get` instead.","parameters":[{"name":"teamDriveId","in":"path","required":true,"description":"The ID of the Team Drive","schema":{"description":"The ID of the Team Drive","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.teamdrives.delete","x-executor-toolPath":"drive.teamdrives.delete","tags":["Google Drive API"],"description":"Deprecated: Use `drives.delete` instead.","parameters":[{"name":"teamDriveId","in":"path","required":true,"description":"The ID of the Team Drive","schema":{"description":"The ID of the Team Drive","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.teamdrives.update","x-executor-toolPath":"drive.teamdrives.update","tags":["Google Drive API"],"description":"Deprecated: Use `drives.update` instead.","parameters":[{"name":"teamDriveId","in":"path","required":true,"description":"The ID of the Team Drive","schema":{"description":"The ID of the Team Drive","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/upload/drive/v3/files":{"post":{"operationId":"drive.files.createMedia","x-executor-toolPath":"drive.files.createMedia","tags":["Google Drive API"],"description":"Creates a file. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Creating files in multiple folders is no longer supported.","schema":{"description":"Deprecated: Creating files in multiple folders is no longer supported.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"ignoreDefaultVisibility","in":"query","required":false,"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","schema":{"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"],"servers":[{"url":"https://www.googleapis.com/"}]}},"/upload/drive/v3/files/{fileId}":{"patch":{"operationId":"drive.files.updateMedia","x-executor-toolPath":"drive.files.updateMedia","tags":["Google Drive API"],"description":"Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). (media upload)","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"addParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to add.","schema":{"description":"A comma-separated list of parent IDs to add.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","schema":{"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"removeParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to remove.","schema":{"description":"A comma-separated list of parent IDs to remove.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"],"servers":[{"url":"https://www.googleapis.com/"}]}}},"components":{"schemas":{"drive_v3_About":{"description":"Information about the user, the user's Drive, and system capabilities.","type":"object","properties":{"appInstalled":{"description":"Whether the user has installed the requesting app.","type":"boolean"},"canCreateDrives":{"description":"Whether the user can create shared drives.","type":"boolean"},"canCreateTeamDrives":{"description":"Deprecated: Use `canCreateDrives` instead.","type":"boolean"},"driveThemes":{"description":"A list of themes that are supported for shared drives.","type":"array","items":{"type":"object","properties":{"backgroundImageLink":{"description":"A link to this theme's background image.","type":"string"},"colorRgb":{"description":"The color of this theme as an RGB hex string.","type":"string"},"id":{"description":"The ID of the theme.","type":"string"}}}},"exportFormats":{"description":"A map of source MIME type to possible targets for all supported exports.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"folderColorPalette":{"description":"The currently supported folder colors as RGB hex strings.","type":"array","items":{"type":"string"}},"importFormats":{"description":"A map of source MIME type to possible targets for all supported imports.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#about\"`.","default":"drive#about","type":"string"},"maxImportSizes":{"description":"A map of maximum import sizes by MIME type, in bytes.","type":"object","additionalProperties":{"format":"int64","type":"string"}},"maxUploadSize":{"description":"The maximum upload size in bytes.","format":"int64","type":"string"},"storageQuota":{"description":"The user's storage quota limits and usage. For users that are part of an organization with pooled storage, information about the limit and usage across all services is for the organization, rather than the individual user. All fields are measured in bytes.","type":"object","properties":{"limit":{"description":"The usage limit, if applicable. This will not be present if the user has unlimited storage. For users that are part of an organization with pooled storage, this is the limit for the organization, rather than the individual user.","format":"int64","type":"string"},"usage":{"description":"The total usage across all services. For users that are part of an organization with pooled storage, this is the usage across all services for the organization, rather than the individual user.","format":"int64","type":"string"},"usageInDrive":{"description":"The usage by all files in Google Drive.","format":"int64","type":"string"},"usageInDriveTrash":{"description":"The usage by trashed files in Google Drive.","format":"int64","type":"string"}}},"teamDriveThemes":{"description":"Deprecated: Use `driveThemes` instead.","type":"array","items":{"type":"object","properties":{"backgroundImageLink":{"description":"Deprecated: Use `driveThemes/backgroundImageLink` instead.","type":"string"},"colorRgb":{"description":"Deprecated: Use `driveThemes/colorRgb` instead.","type":"string"},"id":{"description":"Deprecated: Use `driveThemes/id` instead.","type":"string"}}}},"user":{"$ref":"#/components/schemas/drive_v3_User"}}},"drive_v3_AccessProposal":{"description":"Manage outstanding access proposals on a file.","type":"object","properties":{"createTime":{"description":"The creation time.","format":"google-datetime","type":"string"},"fileId":{"description":"The file ID that the proposal for access is on.","type":"string"},"proposalId":{"description":"The ID of the access proposal.","type":"string"},"recipientEmailAddress":{"description":"The email address of the user that will receive permissions, if accepted.","type":"string"},"requestMessage":{"description":"The message that the requester added to the proposal.","type":"string"},"requesterEmailAddress":{"description":"The email address of the requesting user.","type":"string"},"rolesAndViews":{"description":"A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AccessProposalRoleAndView"}}}},"drive_v3_AccessProposalRoleAndView":{"description":"A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"object","properties":{"role":{"description":"The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`","type":"string"},"view":{"description":"Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.","type":"string"}}},"drive_v3_AddReviewer":{"description":"Representation of a reviewer addition.","type":"object","properties":{"addedReviewerEmail":{"description":"Required. The email of the reviewer to add.","type":"string"}}},"drive_v3_App":{"description":"The `apps` resource provides a list of apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details. Some resource methods (such as `apps.get`) require an `appId`. Use the `apps.list` method to retrieve the ID for an installed application.","type":"object","properties":{"authorized":{"description":"Whether the app is authorized to access data on the user's Drive.","type":"boolean"},"createInFolderTemplate":{"description":"The template URL to create a file with this app in a given folder. The template contains the {folderId} to be replaced by the folder ID house the new file.","type":"string"},"createUrl":{"description":"The URL to create a file with this app.","type":"string"},"hasDriveWideScope":{"description":"Whether the app has Drive-wide scope. An app with Drive-wide scope can access all files in the user's Drive.","type":"boolean"},"icons":{"description":"The various icons for the app.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AppIcons"}},"id":{"description":"The ID of the app.","type":"string"},"installed":{"description":"Whether the app is installed.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#app\".","default":"drive#app","type":"string"},"longDescription":{"description":"A long description of the app.","type":"string"},"name":{"description":"The name of the app.","type":"string"},"objectType":{"description":"The type of object this app creates such as a Chart. If empty, the app name should be used instead.","type":"string"},"openUrlTemplate":{"description":"The template URL for opening files with this app. The template contains {ids} or {exportIds} to be replaced by the actual file IDs. For more information, see Open Files for the full documentation.","type":"string"},"primaryFileExtensions":{"description":"The list of primary file extensions.","type":"array","items":{"type":"string"}},"primaryMimeTypes":{"description":"The list of primary MIME types.","type":"array","items":{"type":"string"}},"productId":{"description":"The ID of the product listing for this app.","type":"string"},"productUrl":{"description":"A link to the product listing for this app.","type":"string"},"secondaryFileExtensions":{"description":"The list of secondary file extensions.","type":"array","items":{"type":"string"}},"secondaryMimeTypes":{"description":"The list of secondary MIME types.","type":"array","items":{"type":"string"}},"shortDescription":{"description":"A short description of the app.","type":"string"},"supportsCreate":{"description":"Whether this app supports creating objects.","type":"boolean"},"supportsImport":{"description":"Whether this app supports importing from Google Docs.","type":"boolean"},"supportsMultiOpen":{"description":"Whether this app supports opening more than one file.","type":"boolean"},"supportsOfflineCreate":{"description":"Whether this app supports creating files when offline.","type":"boolean"},"useByDefault":{"description":"Whether the app is selected as the default handler for the types it supports.","type":"boolean"}}},"drive_v3_AppIcons":{"type":"object","properties":{"category":{"description":"Category of the icon. Allowed values are: * `application` - The icon for the application. * `document` - The icon for a file associated with the app. * `documentShared` - The icon for a shared file associated with the app.","type":"string"},"iconUrl":{"description":"URL for the icon.","type":"string"},"size":{"description":"Size of the icon. Represented as the maximum of the width and height.","format":"int32","type":"integer"}}},"drive_v3_AppList":{"description":"A list of third-party applications which the user has installed or given access to Google Drive.","type":"object","properties":{"defaultAppIds":{"description":"The list of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).","type":"array","items":{"type":"string"}},"items":{"description":"The list of apps.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_App"}},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#appList\".","default":"drive#appList","type":"string"},"selfLink":{"description":"A link back to this list.","type":"string"}}},"drive_v3_Approval":{"description":"Metadata for an approval. An approval is a review or approve process for a Drive item.","type":"object","properties":{"approvalId":{"description":"The approval ID.","type":"string"},"completeTime":{"description":"Output only. The time the approval was completed.","format":"google-datetime","readOnly":true,"type":"string"},"createTime":{"description":"Output only. The time the approval was created.","format":"google-datetime","readOnly":true,"type":"string"},"dueTime":{"description":"The time that the approval is due.","format":"google-datetime","type":"string"},"fileContentChangeBehavior":{"description":"Output only. The behavior of the approval when the file content changes.","readOnly":true,"enum":["FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED","RESET_APPROVAL","NO_APPROVAL_ACTION"],"type":"string"},"initiator":{"$ref":"#/components/schemas/drive_v3_User"},"kind":{"description":"This is always drive#approval.","type":"string"},"modifyTime":{"description":"Output only. The most recent time the approval was modified.","format":"google-datetime","readOnly":true,"type":"string"},"reviewerResponses":{"description":"The responses made on the approval by reviewers.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_ReviewerResponse"}},"status":{"description":"Output only. The status of the approval at the time this resource was requested.","readOnly":true,"enum":["STATUS_UNSPECIFIED","IN_PROGRESS","APPROVED","CANCELLED","DECLINED"],"type":"string"},"targetFileId":{"description":"Target file id of the approval.","type":"string"}}},"drive_v3_ApprovalList":{"description":"The response of an approvals list request.","type":"object","properties":{"items":{"description":"The list of approvals. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Approval"}},"kind":{"description":"This is always drive#approvalList","type":"string"},"nextPageToken":{"description":"The page token for the next page of approvals. This is absent if the end of the approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.","type":"string"}}},"drive_v3_ApproveApprovalRequest":{"description":"Request for approving an approval as a reviewer.","type":"object","properties":{"message":{"description":"Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_CancelApprovalRequest":{"description":"Request for cancelling an approval as an initiator.","type":"object","properties":{"message":{"description":"Optional. A message to accompany the cancellation of the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_Change":{"description":"A change to a file or shared drive.","type":"object","properties":{"changeType":{"description":"The type of the change. Possible values are `file` and `drive`.","type":"string"},"drive":{"$ref":"#/components/schemas/drive_v3_Drive"},"driveId":{"description":"The ID of the shared drive associated with this change.","type":"string"},"file":{"$ref":"#/components/schemas/drive_v3_File"},"fileId":{"description":"The ID of the file which has changed.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#change\"`.","default":"drive#change","type":"string"},"removed":{"description":"Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.","type":"boolean"},"teamDrive":{"$ref":"#/components/schemas/drive_v3_TeamDrive"},"teamDriveId":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"time":{"description":"The time of this change (RFC 3339 date-time).","format":"date-time","type":"string"},"type":{"description":"Deprecated: Use `changeType` instead.","type":"string"}}},"drive_v3_ChangeList":{"description":"A list of changes for a user.","type":"object","properties":{"changes":{"description":"The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Change"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#changeList\"`.","default":"drive#changeList","type":"string"},"newStartPageToken":{"description":"The starting page token for future changes. This will be present only if the end of the current changes list has been reached. The page token doesn't expire.","type":"string"},"nextPageToken":{"description":"The page token for the next page of changes. This will be absent if the end of the changes list has been reached. The page token doesn't expire.","type":"string"}}},"drive_v3_Channel":{"description":"A notification channel used to watch for resource changes.","type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional.","type":"object","additionalProperties":{"type":"string"}},"payload":{"description":"A Boolean value to indicate whether payload is wanted. Optional.","type":"boolean"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel. Valid values are \"web_hook\" or \"webhook\".","type":"string"}}},"drive_v3_ClientEncryptionDetails":{"description":"Details about the client-side encryption applied to the file.","type":"object","properties":{"decryptionMetadata":{"$ref":"#/components/schemas/drive_v3_DecryptionMetadata"},"encryptionState":{"description":"The encryption state of the file. The values expected here are: - encrypted - unencrypted ","type":"string"}}},"drive_v3_Comment":{"description":"A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.","type":"object","properties":{"anchor":{"description":"A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).","type":"string"},"assigneeEmailAddress":{"description":"Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.","readOnly":true,"type":"string"},"author":{"$ref":"#/components/schemas/drive_v3_User"},"content":{"description":"The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.","type":"string"},"createdTime":{"description":"The time at which the comment was created (RFC 3339 date-time).","format":"date-time","type":"string"},"deleted":{"description":"Output only. Whether the comment has been deleted. A deleted comment has no content.","type":"boolean"},"htmlContent":{"description":"Output only. The content of the comment with HTML formatting.","type":"string"},"id":{"description":"Output only. The ID of the comment.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.","default":"drive#comment","type":"string"},"mentionedEmailAddresses":{"description":"Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.","readOnly":true,"type":"array","items":{"type":"string"}},"modifiedTime":{"description":"The last time the comment or any of its replies was modified (RFC 3339 date-time).","format":"date-time","type":"string"},"quotedFileContent":{"description":"The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.","type":"object","properties":{"mimeType":{"description":"The MIME type of the quoted content.","type":"string"},"value":{"description":"The quoted content itself. This is interpreted as plain text if set through the API.","type":"string"}}},"replies":{"description":"Output only. The full list of replies to the comment in chronological order.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Reply"}},"resolved":{"description":"Output only. Whether the comment has been resolved by one of its replies.","type":"boolean"}}},"drive_v3_CommentApprovalRequest":{"description":"Request for commenting on an approval.","type":"object","properties":{"message":{"description":"Required. A message to comment on the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_CommentList":{"description":"A list of comments on a file.","type":"object","properties":{"comments":{"description":"The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Comment"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#commentList\"`.","default":"drive#commentList","type":"string"},"nextPageToken":{"description":"The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_ContentRestriction":{"description":"A restriction for accessing the content of the file.","type":"object","properties":{"ownerRestricted":{"description":"Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.","type":"boolean"},"readOnly":{"description":"Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.","type":"boolean"},"reason":{"description":"Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.","type":"string"},"restrictingUser":{"$ref":"#/components/schemas/drive_v3_User"},"restrictionTime":{"description":"The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.","format":"date-time","type":"string"},"systemRestricted":{"description":"Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.","type":"boolean"},"type":{"description":"Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.","type":"string"}}},"drive_v3_DeclineApprovalRequest":{"description":"Request for declining an approval as a reviewer.","type":"object","properties":{"message":{"description":"Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_DecryptionMetadata":{"description":"Representation of the CSE DecryptionMetadata.","type":"object","properties":{"aes256GcmChunkSize":{"description":"Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small ","type":"string"},"encryptionResourceKeyHash":{"description":"The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference","type":"string"},"jwt":{"description":"The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file.","type":"string"},"kaclsId":{"description":"The ID of the KACLS (Key ACL Service) used to encrypt the file.","format":"int64","type":"string"},"kaclsName":{"description":"The name of the KACLS (Key ACL Service) used to encrypt the file.","type":"string"},"keyFormat":{"description":"Key format for the unwrapped key. Must be `tinkAesGcmKey`.","type":"string"},"wrappedKey":{"description":"The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file.","type":"string"}}},"drive_v3_DownloadRestriction":{"description":"A restriction for copy and download of the file.","type":"object","properties":{"restrictedForReaders":{"description":"Whether download and copy is restricted for readers.","type":"boolean"},"restrictedForWriters":{"description":"Whether download and copy is restricted for writers. If true, download is also restricted for readers.","type":"boolean"}}},"drive_v3_DownloadRestrictionsMetadata":{"description":"Download restrictions applied to the file.","type":"object","properties":{"effectiveDownloadRestrictionWithContext":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"},"itemDownloadRestriction":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"}}},"drive_v3_Drive":{"description":"Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.","type":"object","properties":{"backgroundImageFile":{"description":"An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.","type":"object","properties":{"id":{"description":"The ID of an image file in Google Drive to use for the background image.","type":"string"},"width":{"description":"The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.","format":"float","type":"number"},"xCoordinate":{"description":"The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.","format":"float","type":"number"},"yCoordinate":{"description":"The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.","format":"float","type":"number"}}},"backgroundImageLink":{"description":"Output only. A short-lived link to this shared drive's background image.","type":"string"},"capabilities":{"description":"Output only. Capabilities the current user has on this shared drive.","type":"object","properties":{"canAddChildren":{"description":"Output only. Whether the current user can add children to folders in this shared drive.","type":"boolean"},"canChangeCopyRequiresWriterPermissionRestriction":{"description":"Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.","type":"boolean"},"canChangeDomainUsersOnlyRestriction":{"description":"Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.","type":"boolean"},"canChangeDownloadRestriction":{"description":"Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.","type":"boolean"},"canChangeDriveBackground":{"description":"Output only. Whether the current user can change the background of this shared drive.","type":"boolean"},"canChangeDriveMembersOnlyRestriction":{"description":"Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.","type":"boolean"},"canChangeSharingFoldersRequiresOrganizerPermissionRestriction":{"description":"Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.","type":"boolean"},"canComment":{"description":"Output only. Whether the current user can comment on files in this shared drive.","type":"boolean"},"canCopy":{"description":"Output only. Whether the current user can copy files in this shared drive.","type":"boolean"},"canDeleteChildren":{"description":"Output only. Whether the current user can delete children from folders in this shared drive.","type":"boolean"},"canDeleteDrive":{"description":"Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.","type":"boolean"},"canDownload":{"description":"Output only. Whether the current user can download files in this shared drive.","type":"boolean"},"canEdit":{"description":"Output only. Whether the current user can edit files in this shared drive","type":"boolean"},"canListChildren":{"description":"Output only. Whether the current user can list the children of folders in this shared drive.","type":"boolean"},"canManageMembers":{"description":"Output only. Whether the current user can add members to this shared drive or remove them or change their role.","type":"boolean"},"canReadRevisions":{"description":"Output only. Whether the current user can read the revisions resource of files in this shared drive.","type":"boolean"},"canRename":{"description":"Output only. Whether the current user can rename files or folders in this shared drive.","type":"boolean"},"canRenameDrive":{"description":"Output only. Whether the current user can rename this shared drive.","type":"boolean"},"canResetDriveRestrictions":{"description":"Output only. Whether the current user can reset the shared drive restrictions to defaults.","type":"boolean"},"canShare":{"description":"Output only. Whether the current user can share files or folders in this shared drive.","type":"boolean"},"canTrashChildren":{"description":"Output only. Whether the current user can trash children from folders in this shared drive.","type":"boolean"}}},"colorRgb":{"description":"The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.","type":"string"},"createdTime":{"description":"The time at which the shared drive was created (RFC 3339 date-time).","format":"date-time","type":"string"},"hidden":{"description":"Whether the shared drive is hidden from default view.","type":"boolean"},"id":{"description":"Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#drive\"`.","default":"drive#drive","type":"string"},"name":{"description":"The name of this shared drive.","type":"string"},"orgUnitId":{"description":"Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.","type":"string"},"restrictions":{"description":"A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.","type":"object","properties":{"adminManagedRestrictions":{"description":"Whether administrative privileges on this shared drive are required to modify restrictions.","type":"boolean"},"copyRequiresWriterPermission":{"description":"Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.","type":"boolean"},"domainUsersOnly":{"description":"Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.","type":"boolean"},"downloadRestriction":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"},"driveMembersOnly":{"description":"Whether access to items inside this shared drive is restricted to its members.","type":"boolean"},"sharingFoldersRequiresOrganizerPermission":{"description":"If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.","type":"boolean"}}},"themeId":{"description":"The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.","type":"string"}}},"drive_v3_DriveList":{"description":"A list of shared drives.","type":"object","properties":{"drives":{"description":"The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Drive"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#driveList\"`.","default":"drive#driveList","type":"string"},"nextPageToken":{"description":"The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_File":{"description":"The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.","type":"object","properties":{"appProperties":{"description":"A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.","type":"object","additionalProperties":{"type":"string"}},"capabilities":{"description":"Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).","type":"object","properties":{"canAcceptOwnership":{"description":"Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.","type":"boolean"},"canAccessViaGenAi":{"description":"Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility).","type":"boolean"},"canAddChildren":{"description":"Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.","type":"boolean"},"canAddFolderFromAnotherDrive":{"description":"Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canAddMyDriveParent":{"description":"Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.","type":"boolean"},"canChangeCopyRequiresWriterPermission":{"description":"Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.","type":"boolean"},"canChangeItemDownloadRestriction":{"description":"Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.","type":"boolean"},"canChangeSecurityUpdateEnabled":{"description":"Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.","type":"boolean"},"canChangeViewersCanCopyContent":{"description":"Deprecated: Output only.","type":"boolean"},"canComment":{"description":"Output only. Whether the current user can comment on this file.","type":"boolean"},"canCopy":{"description":"Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder.","type":"boolean"},"canDelete":{"description":"Output only. Whether the current user can delete this file.","type":"boolean"},"canDeleteChildren":{"description":"Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canDisableInheritedPermissions":{"description":"Whether a user can disable inherited permissions.","type":"boolean"},"canDownload":{"description":"Output only. Whether the current user can download this file.","type":"boolean"},"canEdit":{"description":"Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.","type":"boolean"},"canEnableInheritedPermissions":{"description":"Whether a user can re-enable inherited permissions.","type":"boolean"},"canListChildren":{"description":"Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.","type":"boolean"},"canModifyContent":{"description":"Output only. Whether the current user can modify the content of this file.","type":"boolean"},"canModifyContentRestriction":{"description":"Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.","type":"boolean"},"canModifyEditorContentRestriction":{"description":"Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.","type":"boolean"},"canModifyLabels":{"description":"Output only. Whether the current user can modify the labels on the file.","type":"boolean"},"canModifyOwnerContentRestriction":{"description":"Output only. Whether the current user can add or modify content restrictions which are owner restricted.","type":"boolean"},"canMoveChildrenOutOfDrive":{"description":"Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canMoveChildrenOutOfTeamDrive":{"description":"Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.","type":"boolean"},"canMoveChildrenWithinDrive":{"description":"Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.","type":"boolean"},"canMoveChildrenWithinTeamDrive":{"description":"Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.","type":"boolean"},"canMoveItemIntoTeamDrive":{"description":"Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.","type":"boolean"},"canMoveItemOutOfDrive":{"description":"Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added.","type":"boolean"},"canMoveItemOutOfTeamDrive":{"description":"Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.","type":"boolean"},"canMoveItemWithinDrive":{"description":"Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.","type":"boolean"},"canMoveItemWithinTeamDrive":{"description":"Deprecated: Output only. Use `canMoveItemWithinDrive` instead.","type":"boolean"},"canMoveTeamDriveItem":{"description":"Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.","type":"boolean"},"canReadDrive":{"description":"Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.","type":"boolean"},"canReadLabels":{"description":"Output only. Whether the current user can read the labels on the file.","type":"boolean"},"canReadRevisions":{"description":"Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read.","type":"boolean"},"canReadTeamDrive":{"description":"Deprecated: Output only. Use `canReadDrive` instead.","type":"boolean"},"canRemoveChildren":{"description":"Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.","type":"boolean"},"canRemoveContentRestriction":{"description":"Output only. Whether there's a content restriction on the file that can be removed by the current user.","type":"boolean"},"canRemoveMyDriveParent":{"description":"Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.","type":"boolean"},"canRename":{"description":"Output only. Whether the current user can rename this file.","type":"boolean"},"canShare":{"description":"Output only. Whether the current user can modify the sharing settings for this file.","type":"boolean"},"canStartApproval":{"description":"Whether the current user can start an approval on the file.","type":"boolean"},"canTrash":{"description":"Output only. Whether the current user can move this file to trash.","type":"boolean"},"canTrashChildren":{"description":"Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canUntrash":{"description":"Output only. Whether the current user can restore this file from trash.","type":"boolean"}}},"clientEncryptionDetails":{"$ref":"#/components/schemas/drive_v3_ClientEncryptionDetails"},"contentHints":{"description":"Additional information about the content of the file. These fields are never populated in responses.","type":"object","properties":{"indexableText":{"description":"Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.","type":"string"},"thumbnail":{"description":"A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.","type":"object","properties":{"image":{"description":"The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).","format":"byte","type":"string"},"mimeType":{"description":"The MIME type of the thumbnail.","type":"string"}}}}},"contentRestrictions":{"description":"Restrictions for accessing the content of the file. Only populated if such a restriction exists.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_ContentRestriction"}},"copyRequiresWriterPermission":{"description":"Whether the options to copy, print, or download this file should be disabled for readers and commenters.","type":"boolean"},"createdTime":{"description":"The time at which the file was created (RFC 3339 date-time).","format":"date-time","type":"string"},"description":{"description":"A short description of the file.","type":"string"},"downloadRestrictions":{"$ref":"#/components/schemas/drive_v3_DownloadRestrictionsMetadata"},"driveId":{"description":"Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.","type":"string"},"explicitlyTrashed":{"description":"Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.","type":"boolean"},"exportLinks":{"description":"Output only. Links for exporting Docs Editors files to specific formats.","readOnly":true,"type":"object","additionalProperties":{"type":"string"}},"fileExtension":{"description":"Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.","type":"string"},"folderColorRgb":{"description":"The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.","type":"string"},"fullFileExtension":{"description":"Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension.","type":"string"},"hasAugmentedPermissions":{"description":"Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.","type":"boolean"},"hasThumbnail":{"description":"Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.","type":"boolean"},"headRevisionId":{"description":"Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.","type":"string"},"iconLink":{"description":"Output only. A static, unauthenticated link to the file's icon.","type":"string"},"id":{"description":"The ID of the file.","type":"string"},"imageMediaMetadata":{"description":"Output only. Additional metadata about image media, if available.","type":"object","properties":{"aperture":{"description":"Output only. The aperture used to create the photo (f-number).","format":"float","type":"number"},"cameraMake":{"description":"Output only. The make of the camera used to create the photo.","type":"string"},"cameraModel":{"description":"Output only. The model of the camera used to create the photo.","type":"string"},"colorSpace":{"description":"Output only. The color space of the photo.","type":"string"},"exposureBias":{"description":"Output only. The exposure bias of the photo (APEX value).","format":"float","type":"number"},"exposureMode":{"description":"Output only. The exposure mode used to create the photo.","type":"string"},"exposureTime":{"description":"Output only. The length of the exposure, in seconds.","format":"float","type":"number"},"flashUsed":{"description":"Output only. Whether a flash was used to create the photo.","type":"boolean"},"focalLength":{"description":"Output only. The focal length used to create the photo, in millimeters.","format":"float","type":"number"},"height":{"description":"Output only. The height of the image in pixels.","format":"int32","type":"integer"},"isoSpeed":{"description":"Output only. The ISO speed used to create the photo.","format":"int32","type":"integer"},"lens":{"description":"Output only. The lens used to create the photo.","type":"string"},"location":{"description":"Output only. Geographic location information stored in the image.","type":"object","properties":{"altitude":{"description":"Output only. The altitude stored in the image.","format":"double","type":"number"},"latitude":{"description":"Output only. The latitude stored in the image.","format":"double","type":"number"},"longitude":{"description":"Output only. The longitude stored in the image.","format":"double","type":"number"}}},"maxApertureValue":{"description":"Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).","format":"float","type":"number"},"meteringMode":{"description":"Output only. The metering mode used to create the photo.","type":"string"},"rotation":{"description":"Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.","format":"int32","type":"integer"},"sensor":{"description":"Output only. The type of sensor used to create the photo.","type":"string"},"subjectDistance":{"description":"Output only. The distance to the subject of the photo, in meters.","format":"int32","type":"integer"},"time":{"description":"Output only. The date and time the photo was taken (EXIF DateTime).","type":"string"},"whiteBalance":{"description":"Output only. The white balance mode used to create the photo.","type":"string"},"width":{"description":"Output only. The width of the image in pixels.","format":"int32","type":"integer"}}},"inheritedPermissionsDisabled":{"description":"Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.","type":"boolean"},"isAppAuthorized":{"description":"Output only. Whether the file was created or opened by the requesting app.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#file\"`.","default":"drive#file","type":"string"},"labelInfo":{"description":"Label information on the file.","type":"object","properties":{"labels":{"description":"Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Label"}}}},"lastModifyingUser":{"$ref":"#/components/schemas/drive_v3_User"},"linkShareMetadata":{"description":"Contains details about the link URLs that clients are using to refer to this item.","type":"object","properties":{"securityUpdateEligible":{"description":"Output only. Whether the file is eligible for security update.","type":"boolean"},"securityUpdateEnabled":{"description":"Output only. Whether the security update is enabled for this file.","type":"boolean"}}},"md5Checksum":{"description":"Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.","type":"string"},"mimeType":{"description":"The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.","type":"string"},"modifiedByMe":{"description":"Output only. Whether the file has been modified by this user.","type":"boolean"},"modifiedByMeTime":{"description":"The last time the file was modified by the user (RFC 3339 date-time).","format":"date-time","type":"string"},"modifiedTime":{"description":"he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.","format":"date-time","type":"string"},"name":{"description":"The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.","type":"string"},"originalFilename":{"description":"The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive.","type":"string"},"ownedByMe":{"description":"Output only. Whether the user owns the file. Not populated for items in shared drives.","type":"boolean"},"owners":{"description":"Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_User"}},"parents":{"description":"The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.","type":"array","items":{"type":"string"}},"permissionIds":{"description":"Output only. List of permission IDs for users with access to this file.","type":"array","items":{"type":"string"}},"permissions":{"description":"Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Permission"}},"properties":{"description":"A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.","type":"object","additionalProperties":{"type":"string"}},"quotaBytesUsed":{"description":"Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.","format":"int64","type":"string"},"resourceKey":{"description":"Output only. A key needed to access the item via a shared link.","type":"string"},"sha1Checksum":{"description":"Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.","type":"string"},"sha256Checksum":{"description":"Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.","type":"string"},"shared":{"description":"Output only. Whether the file has been shared. Not populated for items in shared drives.","type":"boolean"},"sharedWithMeTime":{"description":"The time at which the file was shared with the user, if applicable (RFC 3339 date-time).","format":"date-time","type":"string"},"sharingUser":{"$ref":"#/components/schemas/drive_v3_User"},"shortcutDetails":{"description":"Information about a shortcut file.","type":"object","properties":{"targetId":{"description":"The ID of the file that this shortcut points to. Can only be set on `files.create` requests.","type":"string"},"targetMimeType":{"description":"Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.","type":"string"},"targetResourceKey":{"description":"Output only. The `resourceKey` for the target file.","type":"string"}}},"size":{"description":"Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.","format":"int64","type":"string"},"spaces":{"description":"Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.","type":"array","items":{"type":"string"}},"starred":{"description":"Whether the user has starred the file.","type":"boolean"},"teamDriveId":{"description":"Deprecated: Output only. Use `driveId` instead.","type":"string"},"thumbnailLink":{"description":"Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.","type":"string"},"thumbnailVersion":{"description":"Output only. The thumbnail version for use in thumbnail cache invalidation.","format":"int64","type":"string"},"trashed":{"description":"Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted.","type":"boolean"},"trashedTime":{"description":"The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.","format":"date-time","type":"string"},"trashingUser":{"$ref":"#/components/schemas/drive_v3_User"},"version":{"description":"Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.","format":"int64","type":"string"},"videoMediaMetadata":{"description":"Output only. Additional metadata about video media. This may not be available immediately upon upload.","type":"object","properties":{"durationMillis":{"description":"Output only. The duration of the video in milliseconds.","format":"int64","type":"string"},"height":{"description":"Output only. The height of the video in pixels.","format":"int32","type":"integer"},"width":{"description":"Output only. The width of the video in pixels.","format":"int32","type":"integer"}}},"viewedByMe":{"description":"Output only. Whether the file has been viewed by this user.","type":"boolean"},"viewedByMeTime":{"description":"The last time the file was viewed by the user (RFC 3339 date-time).","format":"date-time","type":"string"},"viewersCanCopyContent":{"description":"Deprecated: Use `copyRequiresWriterPermission` instead.","type":"boolean"},"webContentLink":{"description":"Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.","type":"string"},"webViewLink":{"description":"Output only. A link for opening the file in a relevant Google editor or viewer in a browser.","type":"string"},"writersCanShare":{"description":"Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.","type":"boolean"}}},"drive_v3_FileList":{"description":"A list of files.","type":"object","properties":{"files":{"description":"The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_File"}},"incompleteSearch":{"description":"Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`.","type":"boolean"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#fileList\"`.","default":"drive#fileList","type":"string"},"nextPageToken":{"description":"The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_GenerateCseTokenResponse":{"description":"JWT and associated metadata used to generate CSE files.","type":"object","properties":{"currentKaclsId":{"description":"The current Key ACL Service (KACLS) ID associated with the JWT.","format":"int64","type":"string"},"currentKaclsName":{"description":"Name of the KACLs that the returned KACLs ID points to.","type":"string"},"fileId":{"description":"The fileId for which the JWT was generated.","type":"string"},"jwt":{"description":"The signed JSON Web Token (JWT) for the file.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#generateCseTokenResponse\"`.","type":"string"}}},"drive_v3_GeneratedIds":{"description":"A list of generated file IDs which can be provided in create requests.","type":"object","properties":{"ids":{"description":"The IDs generated for the requesting user in the specified space.","type":"array","items":{"type":"string"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#generatedIds\"`.","default":"drive#generatedIds","type":"string"},"space":{"description":"The type of file that can be created with these IDs.","type":"string"}}},"drive_v3_Label":{"description":"Representation of label and label fields.","type":"object","properties":{"fields":{"description":"A map of the fields on the label, keyed by the field's ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/drive_v3_LabelField"}},"id":{"description":"The ID of the label.","type":"string"},"kind":{"description":"This is always drive#label","type":"string"},"revisionId":{"description":"The revision ID of the label.","type":"string"}}},"drive_v3_LabelField":{"description":"Representation of field, which is a typed key-value pair.","type":"object","properties":{"dateString":{"description":"Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.","type":"array","items":{"format":"date","type":"string"}},"id":{"description":"The identifier of this label field.","type":"string"},"integer":{"description":"Only present if `valueType` is `integer`.","type":"array","items":{"format":"int64","type":"string"}},"kind":{"description":"This is always drive#labelField.","type":"string"},"selection":{"description":"Only present if `valueType` is `selection`","type":"array","items":{"type":"string"}},"text":{"description":"Only present if `valueType` is `text`.","type":"array","items":{"type":"string"}},"user":{"description":"Only present if `valueType` is `user`.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_User"}},"valueType":{"description":"The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`","type":"string"}}},"drive_v3_LabelFieldModification":{"description":"A modification to a label's field.","type":"object","properties":{"fieldId":{"description":"The ID of the field to be modified.","type":"string"},"kind":{"description":"This is always `\"drive#labelFieldModification\"`.","type":"string"},"setDateValues":{"description":"Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD.","type":"array","items":{"format":"date","type":"string"}},"setIntegerValues":{"description":"Replaces the value of an `integer` field with these new values.","type":"array","items":{"format":"int64","type":"string"}},"setSelectionValues":{"description":"Replaces a `selection` field with these new values.","type":"array","items":{"type":"string"}},"setTextValues":{"description":"Sets the value of a `text` field.","type":"array","items":{"type":"string"}},"setUserValues":{"description":"Replaces a `user` field with these new values. The values must be a valid email addresses.","type":"array","items":{"type":"string"}},"unsetValues":{"description":"Unsets the values for this field.","type":"boolean"}}},"drive_v3_LabelList":{"description":"A list of labels applied to a file.","type":"object","properties":{"kind":{"description":"This is always `\"drive#labelList\"`.","type":"string"},"labels":{"description":"The list of labels.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Label"}},"nextPageToken":{"description":"The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_LabelModification":{"description":"A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.","type":"object","properties":{"fieldModifications":{"description":"The list of modifications to this label's fields.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_LabelFieldModification"}},"kind":{"description":"This is always `\"drive#labelModification\"`.","type":"string"},"labelId":{"description":"The ID of the label to modify.","type":"string"},"removeLabel":{"description":"If true, the label will be removed from the file.","type":"boolean"}}},"drive_v3_ListAccessProposalsResponse":{"description":"The response to an access proposal list request.","type":"object","properties":{"accessProposals":{"description":"The list of access proposals. This field is only populated in Drive API v3.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AccessProposal"}},"nextPageToken":{"description":"The continuation token for the next page of results. This will be absent if the end of the results list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.","type":"string"}}},"drive_v3_ModifyLabelsRequest":{"description":"A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.","type":"object","properties":{"kind":{"description":"This is always `\"drive#modifyLabelsRequest\"`.","type":"string"},"labelModifications":{"description":"The list of modifications to apply to the labels on the file.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_LabelModification"}}}},"drive_v3_ModifyLabelsResponse":{"description":"Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request.","type":"object","properties":{"kind":{"description":"This is always `\"drive#modifyLabelsResponse\"`.","type":"string"},"modifiedLabels":{"description":"The list of labels which were added or updated by the request.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Label"}}}},"drive_v3_Operation":{"description":"This resource represents a long-running operation that is the result of a network API call.","type":"object","properties":{"done":{"description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.","type":"boolean"},"error":{"$ref":"#/components/schemas/drive_v3_Status"},"metadata":{"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}},"name":{"description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.","type":"string"},"response":{"description":"The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}}},"drive_v3_Permission":{"description":"A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.","type":"object","properties":{"allowFileDiscovery":{"description":"Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.","type":"boolean"},"deleted":{"description":"Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`.","type":"boolean"},"displayName":{"description":"Output only. The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as \"Dana A.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"cymbalgroup.com.\" * `anyone` - No `displayName` is present.","type":"string"},"domain":{"description":"Output only. The domain to which this permission refers.","readOnly":true,"type":"string"},"emailAddress":{"description":"Output only. The email address of the user or group to which this permission refers.","readOnly":true,"type":"string"},"expirationTime":{"description":"The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future","format":"date-time","type":"string"},"id":{"description":"Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values.","type":"string"},"inheritedPermissionsDisabled":{"description":"When `true`, only organizers, owners, and users with permissions added directly on the item can access it.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.","default":"drive#permission","type":"string"},"pendingOwner":{"description":"Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive.","type":"boolean"},"permissionDetails":{"description":"Output only. Details of whether the permissions on this item are inherited or are directly on this item.","readOnly":true,"type":"array","items":{"type":"object","properties":{"inherited":{"description":"Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.","type":"boolean"},"inheritedFrom":{"description":"Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.","readOnly":true,"type":"string"},"permissionType":{"description":"Output only. The permission type for this user. Supported values include: * `file` * `member`","type":"string"},"role":{"description":"Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"string"}}}},"photoLink":{"description":"Output only. A link to the user's profile photo, if available.","type":"string"},"role":{"description":"The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"string"},"teamDrivePermissionDetails":{"description":"Output only. Deprecated: Output only. Use `permissionDetails` instead.","readOnly":true,"type":"array","items":{"type":"object","properties":{"inherited":{"description":"Deprecated: Output only. Use `permissionDetails/inherited` instead.","type":"boolean"},"inheritedFrom":{"description":"Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.","type":"string"},"role":{"description":"Deprecated: Output only. Use `permissionDetails/role` instead.","type":"string"},"teamDrivePermissionType":{"description":"Deprecated: Output only. Use `permissionDetails/permissionType` instead.","type":"string"}}}},"type":{"description":"The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required.","type":"string"},"view":{"description":"Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views).","type":"string"}}},"drive_v3_PermissionList":{"description":"A list of permissions for a file.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#permissionList\"`.","default":"drive#permissionList","type":"string"},"nextPageToken":{"description":"The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"permissions":{"description":"The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Permission"}}}},"drive_v3_ReassignApprovalRequest":{"description":"Request for reassigning an approval. Reviewers can be added or replaced, but not removed.","type":"object","properties":{"addReviewers":{"description":"Optional. The list of reviewers to add.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AddReviewer"}},"message":{"description":"Optional. A message to send to the new reviewers. This message is included in notifications for the action and in the approval activity log.","type":"string"},"replaceReviewers":{"description":"Optional. The list of reviewer replacements.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_ReplaceReviewer"}}}},"drive_v3_ReplaceReviewer":{"description":"Representation of a reviewer replacement.","type":"object","properties":{"addedReviewerEmail":{"description":"Required. The email of the reviewer to add.","type":"string"},"removedReviewerEmail":{"description":"Required. The email of the reviewer to remove.","type":"string"}}},"drive_v3_Reply":{"description":"A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.","type":"object","properties":{"action":{"description":"The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`","type":"string"},"assigneeEmailAddress":{"description":"Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.","readOnly":true,"type":"string"},"author":{"$ref":"#/components/schemas/drive_v3_User"},"content":{"description":"The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.","type":"string"},"createdTime":{"description":"The time at which the reply was created (RFC 3339 date-time).","format":"date-time","type":"string"},"deleted":{"description":"Output only. Whether the reply has been deleted. A deleted reply has no content.","type":"boolean"},"htmlContent":{"description":"Output only. The content of the reply with HTML formatting.","type":"string"},"id":{"description":"Output only. The ID of the reply.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`.","default":"drive#reply","type":"string"},"mentionedEmailAddresses":{"description":"Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.","readOnly":true,"type":"array","items":{"type":"string"}},"modifiedTime":{"description":"The last time the reply was modified (RFC 3339 date-time).","format":"date-time","type":"string"}}},"drive_v3_ReplyList":{"description":"A list of replies to a comment on a file.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#replyList\"`.","default":"drive#replyList","type":"string"},"nextPageToken":{"description":"The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"replies":{"description":"The list of replies. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Reply"}}}},"drive_v3_ResolveAccessProposalRequest":{"description":"Request message for resolving an AccessProposal on a file.","type":"object","properties":{"action":{"description":"Required. The action to take on the access proposal.","enum":["ACTION_UNSPECIFIED","ACCEPT","DENY"],"type":"string"},"role":{"description":"Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.","type":"array","items":{"type":"string"}},"sendNotification":{"description":"Optional. Whether to send an email to the requester when the access proposal is denied or accepted.","type":"boolean"},"view":{"description":"Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.","type":"string"}}},"drive_v3_ReviewerResponse":{"description":"A response on an approval made by a specific reviewer.","type":"object","properties":{"kind":{"description":"This is always drive#reviewerResponse.","type":"string"},"response":{"description":"A reviewer’s response for the approval.","enum":["RESPONSE_UNSPECIFIED","NO_RESPONSE","APPROVED","DECLINED"],"type":"string"},"reviewer":{"$ref":"#/components/schemas/drive_v3_User"}}},"drive_v3_Revision":{"description":"The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.","type":"object","properties":{"exportLinks":{"description":"Output only. Links for exporting Docs Editors files to specific formats.","type":"object","additionalProperties":{"type":"string"}},"id":{"description":"Output only. The ID of the revision.","type":"string"},"keepForever":{"description":"Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#revision\"`.","default":"drive#revision","type":"string"},"lastModifyingUser":{"$ref":"#/components/schemas/drive_v3_User"},"md5Checksum":{"description":"Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.","type":"string"},"mimeType":{"description":"Output only. The MIME type of the revision.","type":"string"},"modifiedTime":{"description":"The last time the revision was modified (RFC 3339 date-time).","format":"date-time","type":"string"},"originalFilename":{"description":"Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.","type":"string"},"publishAuto":{"description":"Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.","type":"boolean"},"published":{"description":"Whether this revision is published. This is only applicable to Docs Editors files.","type":"boolean"},"publishedLink":{"description":"Output only. A link to the published revision. This is only populated for Docs Editors files.","type":"string"},"publishedOutsideDomain":{"description":"Whether this revision is published outside the domain. This is only applicable to Docs Editors files.","type":"boolean"},"size":{"description":"Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.","format":"int64","type":"string"}}},"drive_v3_RevisionList":{"description":"A list of revisions of a file.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#revisionList\"`.","default":"drive#revisionList","type":"string"},"nextPageToken":{"description":"The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"revisions":{"description":"The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Revision"}}}},"drive_v3_StartApprovalRequest":{"description":"Allows creating an approval on a file.","type":"object","properties":{"dueTime":{"description":"Optional. The time that the approval is due.","format":"google-datetime","type":"string"},"fileContentChangeBehavior":{"description":"Optional. The behavior of the approval when the file content changes.","enum":["FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED","RESET_APPROVAL","NO_APPROVAL_ACTION"],"type":"string"},"lockFile":{"description":"Optional. Whether to lock the file when starting the approval.","type":"boolean"},"message":{"description":"Optional. A message to send to reviewers when notifying them of the approval request.","type":"string"},"reviewerEmails":{"description":"Required. The emails of the users who are set to review the approval.","type":"array","items":{"type":"string"}}}},"drive_v3_StartPageToken":{"type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`.","default":"drive#startPageToken","type":"string"},"startPageToken":{"description":"The starting page token for listing future changes. The page token doesn't expire.","type":"string"}}},"drive_v3_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"drive_v3_TeamDrive":{"description":"Deprecated: use the drive collection instead. Next ID: 33","type":"object","properties":{"backgroundImageFile":{"description":"The background image file for a Team Drive.","type":"object","properties":{"id":{"description":"The ID of an image file in Drive to use for the background image.","type":"string"},"width":{"description":"The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.","format":"float","type":"number"},"xCoordinate":{"description":"The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.","format":"float","type":"number"},"yCoordinate":{"description":"The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.","format":"float","type":"number"}}},"backgroundImageLink":{"description":"A short-lived link to this Team Drive's background image.","type":"string"},"capabilities":{"description":"Capabilities the current user has on this Team Drive.","type":"object","properties":{"canAddChildren":{"description":"Whether the current user can add children to folders in this Team Drive.","type":"boolean"},"canChangeCopyRequiresWriterPermissionRestriction":{"description":"Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.","type":"boolean"},"canChangeDomainUsersOnlyRestriction":{"description":"Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.","type":"boolean"},"canChangeDownloadRestriction":{"description":"Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.","readOnly":true,"type":"boolean"},"canChangeSharingFoldersRequiresOrganizerPermissionRestriction":{"description":"Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.","type":"boolean"},"canChangeTeamDriveBackground":{"description":"Whether the current user can change the background of this Team Drive.","type":"boolean"},"canChangeTeamMembersOnlyRestriction":{"description":"Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.","type":"boolean"},"canComment":{"description":"Whether the current user can comment on files in this Team Drive.","type":"boolean"},"canCopy":{"description":"Whether the current user can copy files in this Team Drive.","type":"boolean"},"canDeleteChildren":{"description":"Whether the current user can delete children from folders in this Team Drive.","type":"boolean"},"canDeleteTeamDrive":{"description":"Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.","type":"boolean"},"canDownload":{"description":"Whether the current user can download files in this Team Drive.","type":"boolean"},"canEdit":{"description":"Whether the current user can edit files in this Team Drive","type":"boolean"},"canListChildren":{"description":"Whether the current user can list the children of folders in this Team Drive.","type":"boolean"},"canManageMembers":{"description":"Whether the current user can add members to this Team Drive or remove them or change their role.","type":"boolean"},"canReadRevisions":{"description":"Whether the current user can read the revisions resource of files in this Team Drive.","type":"boolean"},"canRemoveChildren":{"description":"Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.","type":"boolean"},"canRename":{"description":"Whether the current user can rename files or folders in this Team Drive.","type":"boolean"},"canRenameTeamDrive":{"description":"Whether the current user can rename this Team Drive.","type":"boolean"},"canResetTeamDriveRestrictions":{"description":"Whether the current user can reset the Team Drive restrictions to defaults.","type":"boolean"},"canShare":{"description":"Whether the current user can share files or folders in this Team Drive.","type":"boolean"},"canTrashChildren":{"description":"Whether the current user can trash children from folders in this Team Drive.","type":"boolean"}}},"colorRgb":{"description":"The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.","type":"string"},"createdTime":{"description":"The time at which the Team Drive was created (RFC 3339 date-time).","format":"date-time","type":"string"},"id":{"description":"The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDrive\"`.","default":"drive#teamDrive","type":"string"},"name":{"description":"The name of this Team Drive.","type":"string"},"orgUnitId":{"description":"The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.","type":"string"},"restrictions":{"description":"A set of restrictions that apply to this Team Drive or items inside this Team Drive.","type":"object","properties":{"adminManagedRestrictions":{"description":"Whether administrative privileges on this Team Drive are required to modify restrictions.","type":"boolean"},"copyRequiresWriterPermission":{"description":"Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive.","type":"boolean"},"domainUsersOnly":{"description":"Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.","type":"boolean"},"downloadRestriction":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"},"sharingFoldersRequiresOrganizerPermission":{"description":"If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.","type":"boolean"},"teamMembersOnly":{"description":"Whether access to items inside this Team Drive is restricted to members of this Team Drive.","type":"boolean"}}},"themeId":{"description":"The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.","type":"string"}}},"drive_v3_TeamDriveList":{"description":"A list of Team Drives.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDriveList\"`.","default":"drive#teamDriveList","type":"string"},"nextPageToken":{"description":"The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"teamDrives":{"description":"The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}},"drive_v3_User":{"description":"Information about a Drive user.","type":"object","properties":{"displayName":{"description":"Output only. A plain text displayable name for this user.","readOnly":true,"type":"string"},"emailAddress":{"description":"Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.","readOnly":true,"type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.","readOnly":true,"default":"drive#user","type":"string"},"me":{"description":"Output only. Whether this user is the requesting user.","readOnly":true,"type":"boolean"},"permissionId":{"description":"Output only. The user's ID as visible in Permission resources.","readOnly":true,"type":"string"},"photoLink":{"description":"Output only. A link to the user's profile photo, if available.","readOnly":true,"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/drive":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/drive"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/drive/v3/rest","service":"drive","version":"v3"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Drive API","version":"v3","description":"The Google Drive API allows clients to access resources from Google Drive."},"servers":[{"url":"https://www.googleapis.com/drive/v3/"}],"paths":{"/about":{"get":{"operationId":"drive.about.get","x-executor-toolPath":"drive.about.get","tags":["Google Drive API"],"description":"Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_About"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/apps/{appId}":{"get":{"operationId":"drive.apps.get","x-executor-toolPath":"drive.apps.get","tags":["Google Drive API"],"description":"Gets a specific app. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info).","parameters":[{"name":"appId","in":"path","required":true,"description":"The ID of the app.","schema":{"description":"The ID of the app.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_App"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/changes":{"get":{"operationId":"drive.changes.list","x-executor-toolPath":"drive.changes.list","tags":["Google Drive API"],"description":"Lists the changes for a user or shared drive. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","schema":{"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeCorpusRemovals","in":"query","required":false,"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","schema":{"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeItemsFromAllDrives","in":"query","required":false,"description":"Whether both My Drive and shared drive items should be included in results.","schema":{"description":"Whether both My Drive and shared drive items should be included in results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","type":"string"},"style":"form","explode":false},{"name":"includeRemoved","in":"query","required":false,"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","schema":{"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"includeTeamDriveItems","in":"query","required":false,"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","schema":{"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":true,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"restrictToMyDrive","in":"query","required":false,"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","schema":{"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"spaces","in":"query","required":false,"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","schema":{"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","default":"drive","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ChangeList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/changes/startPageToken":{"get":{"operationId":"drive.changes.getStartPageToken","x-executor-toolPath":"drive.changes.getStartPageToken","tags":["Google Drive API"],"description":"Gets the starting pageToken for listing future changes. For more information, see [Retrieve changes](https://developers.google.com/workspace/drive/api/guides/manage-changes).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.","schema":{"description":"The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_StartPageToken"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/changes/watch":{"post":{"operationId":"drive.changes.watch","x-executor-toolPath":"drive.changes.watch","tags":["Google Drive API"],"description":"Subscribes to changes for a user. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","schema":{"description":"The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeCorpusRemovals","in":"query","required":false,"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","schema":{"description":"Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeItemsFromAllDrives","in":"query","required":false,"description":"Whether both My Drive and shared drive items should be included in results.","schema":{"description":"Whether both My Drive and shared drive items should be included in results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only 'published' is supported.","type":"string"},"style":"form","explode":false},{"name":"includeRemoved","in":"query","required":false,"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","schema":{"description":"Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"includeTeamDriveItems","in":"query","required":false,"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","schema":{"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of changes to return. The service may return fewer than this value. If unspecified, at most 100 changes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":true,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"restrictToMyDrive","in":"query","required":false,"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","schema":{"description":"Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"spaces","in":"query","required":false,"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","schema":{"description":"A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.","default":"drive","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/channels/stop":{"post":{"operationId":"drive.channels.stop","x-executor-toolPath":"drive.channels.stop","tags":["Google Drive API"],"description":"Stops watching resources through this channel. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/drives":{"get":{"operationId":"drive.drives.list","x-executor-toolPath":"drive.drives.list","tags":["Google Drive API"],"description":"Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](https://developers.google.com/workspace/drive/api/guides/search-shareddrives) guide.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of shared drives to return. The service may return fewer than this value. If unspecified, at most 10 shared drives will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","default":10,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token for shared drives.","schema":{"description":"Page token for shared drives.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Query string for searching shared drives.","schema":{"description":"Query string for searching shared drives.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.","schema":{"description":"Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_DriveList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.drives.create","x-executor-toolPath":"drive.drives.create","tags":["Google Drive API"],"description":"Creates a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":true,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.","schema":{"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/drives/{driveId}":{"get":{"operationId":"drive.drives.get","x-executor-toolPath":"drive.drives.get","tags":["Google Drive API"],"description":"Gets a shared drive's metadata by ID. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.drives.delete","x-executor-toolPath":"drive.drives.delete","tags":["Google Drive API"],"description":"Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allowItemDeletion","in":"query","required":false,"description":"Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.","schema":{"description":"Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.drives.update","x-executor-toolPath":"drive.drives.update","tags":["Google Drive API"],"description":"Updates the metadata for a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/drives/{driveId}/hide":{"post":{"operationId":"drive.drives.hide","x-executor-toolPath":"drive.drives.hide","tags":["Google Drive API"],"description":"Hides a shared drive from the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/drives/{driveId}/unhide":{"post":{"operationId":"drive.drives.unhide","x-executor-toolPath":"drive.drives.unhide","tags":["Google Drive API"],"description":"Restores a shared drive to the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).","parameters":[{"name":"driveId","in":"path","required":true,"description":"The ID of the shared drive.","schema":{"description":"The ID of the shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Drive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files":{"get":{"operationId":"drive.files.list","x-executor-toolPath":"drive.files.list","tags":["Google Drive API"],"description":"Lists the user's files. For more information, see [Search for files and folders](https://developers.google.com/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"corpora","in":"query","required":false,"description":"Specifies a collection of items (files or documents) to which the query applies. Supported items include: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"Specifies a collection of items (files or documents) to which the query applies. Supported items include: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","type":"string"},"style":"form","explode":false},{"name":"corpus","in":"query","required":false,"description":"Deprecated: The source of files to list. Use `corpora` instead.","schema":{"description":"Deprecated: The source of files to list. Use `corpora` instead.","enum":["domain","user"],"type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"ID of the shared drive to search.","schema":{"description":"ID of the shared drive to search.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeItemsFromAllDrives","in":"query","required":false,"description":"Whether both My Drive and shared drive items should be included in results.","schema":{"description":"Whether both My Drive and shared drive items should be included in results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"includeTeamDriveItems","in":"query","required":false,"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","schema":{"description":"Deprecated: Use `includeItemsFromAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"orderBy","in":"query","required":false,"description":"A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use `modifiedTime desc` instead. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.","schema":{"description":"A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. Avoid using this key for queries on large item collections as it might result in timeouts or other issues. For time-related sorting on large item collections, use `modifiedTime desc` instead. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned for shared drives, and the entire list of files for non-shared drives. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).","schema":{"description":"A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"spaces","in":"query","required":false,"description":"A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","default":"drive","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"teamDriveId","in":"query","required":false,"description":"Deprecated: Use `driveId` instead.","schema":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_FileList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.files.create","x-executor-toolPath":"drive.files.create","tags":["Google Drive API"],"description":"Creates a file. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Creating files in multiple folders is no longer supported.","schema":{"description":"Deprecated: Creating files in multiple folders is no longer supported.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"ignoreDefaultVisibility","in":"query","required":false,"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","schema":{"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/generateCseToken":{"get":{"operationId":"drive.files.generateCseToken","x-executor-toolPath":"drive.files.generateCseToken","tags":["Google Drive API"],"description":"Generates a CSE token which can be used to create or update CSE files.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"fileId","in":"query","required":false,"description":"The ID of the file for which the JWT should be generated. If not provided, an id will be generated.","schema":{"description":"The ID of the file for which the JWT should be generated. If not provided, an id will be generated.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.","schema":{"description":"The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_GenerateCseTokenResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/generateIds":{"get":{"operationId":"drive.files.generateIds","x-executor-toolPath":"drive.files.generateIds","tags":["Google Drive API"],"description":"Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"count","in":"query","required":false,"description":"The number of IDs to return.","schema":{"description":"The number of IDs to return.","format":"int32","default":10,"type":"integer"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"space","in":"query","required":false,"description":"The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","default":"drive","type":"string"},"style":"form","explode":false},{"name":"type","in":"query","required":false,"description":"The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","schema":{"description":"The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).","default":"files","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_GeneratedIds"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/trash":{"delete":{"operationId":"drive.files.emptyTrash","x-executor-toolPath":"drive.files.emptyTrash","tags":["Google Drive API"],"description":"Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"driveId","in":"query","required":false,"description":"If set, empties the trash of the provided shared drive.","schema":{"description":"If set, empties the trash of the provided shared drive.","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","schema":{"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/files/{fileId}":{"get":{"operationId":"drive.files.get","x-executor-toolPath":"drive.files.get","tags":["Google Drive API"],"description":"Gets a file's metadata or content by ID. For more information, see [Search for files and folders](https://developers.google.com/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](https://developers.google.com/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"acknowledgeAbuse","in":"query","required":false,"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","schema":{"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.files.delete","x-executor-toolPath":"drive.files.delete","tags":["Google Drive API"],"description":"Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","schema":{"description":"Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.files.update","x-executor-toolPath":"drive.files.update","tags":["Google Drive API"],"description":"Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"addParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to add.","schema":{"description":"A comma-separated list of parent IDs to add.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","schema":{"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"removeParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to remove.","schema":{"description":"A comma-separated list of parent IDs to remove.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.scripts"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.scripts","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/accessproposals":{"get":{"operationId":"drive.accessproposals.list","x-executor-toolPath":"drive.accessproposals.list","tags":["Google Drive API"],"description":"List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the item the request is on.","schema":{"description":"Required. The ID of the item the request is on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of results per page.","schema":{"description":"Optional. The number of results per page.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. The continuation token on the list of access requests.","schema":{"description":"Optional. The continuation token on the list of access requests.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ListAccessProposalsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/accessproposals/{proposalId}":{"get":{"operationId":"drive.accessproposals.get","x-executor-toolPath":"drive.accessproposals.get","tags":["Google Drive API"],"description":"Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the item the request is on.","schema":{"description":"Required. The ID of the item the request is on.","type":"string"}},{"name":"proposalId","in":"path","required":true,"description":"Required. The ID of the access proposal to resolve.","schema":{"description":"Required. The ID of the access proposal to resolve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_AccessProposal"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/accessproposals/{proposalId}:resolve":{"post":{"operationId":"drive.accessproposals.resolve","x-executor-toolPath":"drive.accessproposals.resolve","tags":["Google Drive API"],"description":"Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the item the request is on.","schema":{"description":"Required. The ID of the item the request is on.","type":"string"}},{"name":"proposalId","in":"path","required":true,"description":"Required. The ID of the access proposal to resolve.","schema":{"description":"Required. The ID of the access proposal to resolve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ResolveAccessProposalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals":{"get":{"operationId":"drive.approvals.list","x-executor-toolPath":"drive.approvals.list","tags":["Google Drive API"],"description":"Lists the approvals on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). By default, this method returns a minimal response that may not include the items array. To retrieve approval details, you must explicitly specify the fields you want using the `fields` query parameter. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of approvals to return. When not set, at most 100 approvals are returned.","schema":{"description":"The maximum number of approvals to return. When not set, at most 100 approvals are returned.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ApprovalList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}":{"get":{"operationId":"drive.approvals.get","x-executor-toolPath":"drive.approvals.get","tags":["Google Drive API"],"description":"Gets an approval by ID. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval.","schema":{"description":"Required. The ID of the approval.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:approve":{"post":{"operationId":"drive.approvals.approve","x-executor-toolPath":"drive.approvals.approve","tags":["Google Drive API"],"description":"Approves an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `APPROVED`. If this is the last required reviewer response, this also completes the approval and sets the approval Status to `APPROVED`.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to approve.","schema":{"description":"Required. The ID of the approval to approve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ApproveApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:cancel":{"post":{"operationId":"drive.approvals.cancel","x-executor-toolPath":"drive.approvals.cancel","tags":["Google Drive API"],"description":"Cancels an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Updates the approval Status to `CANCELLED`. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS`.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to cancel.","schema":{"description":"Required. The ID of the approval to cancel.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_CancelApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:comment":{"post":{"operationId":"drive.approvals.comment","x-executor-toolPath":"drive.approvals.comment","tags":["Google Drive API"],"description":"Comments on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to comment on.","schema":{"description":"Required. The ID of the approval to comment on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_CommentApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:decline":{"post":{"operationId":"drive.approvals.decline","x-executor-toolPath":"drive.approvals.decline","tags":["Google Drive API"],"description":"Declines an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `DECLINED`. This also completes the approval and sets the approval Status to `DECLINED`.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to decline.","schema":{"description":"Required. The ID of the approval to decline.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_DeclineApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals/{approvalId}:reassign":{"post":{"operationId":"drive.approvals.reassign","x-executor-toolPath":"drive.approvals.reassign","tags":["Google Drive API"],"description":"Reassigns the reviewers on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS` and the Response for the reviewer being reassigned is `NO_RESPONSE`. A user with the `reader` permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is on.","schema":{"description":"Required. The ID of the file that the approval is on.","type":"string"}},{"name":"approvalId","in":"path","required":true,"description":"Required. The ID of the approval to reassign.","schema":{"description":"Required. The ID of the approval to reassign.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ReassignApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/approvals:start":{"post":{"operationId":"drive.approvals.start","x-executor-toolPath":"drive.approvals.start","tags":["Google Drive API"],"description":"Starts an approval on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file that the approval is created on.","schema":{"description":"Required. The ID of the file that the approval is created on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_StartApprovalRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Approval"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments":{"get":{"operationId":"drive.comments.list","x-executor-toolPath":"drive.comments.list","tags":["Google Drive API"],"description":"Lists a file's comments. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to include deleted comments. Deleted comments will not include their original content.","schema":{"description":"Whether to include deleted comments. Deleted comments will not include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of comments to return. The service may return fewer than this value. If unspecified, at most 20 comments will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startModifiedTime","in":"query","required":false,"description":"The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).","schema":{"description":"The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_CommentList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.comments.create","x-executor-toolPath":"drive.comments.create","tags":["Google Drive API"],"description":"Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments/{commentId}":{"get":{"operationId":"drive.comments.get","x-executor-toolPath":"drive.comments.get","tags":["Google Drive API"],"description":"Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to return deleted comments. Deleted comments will not include their original content.","schema":{"description":"Whether to return deleted comments. Deleted comments will not include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.comments.delete","x-executor-toolPath":"drive.comments.delete","tags":["Google Drive API"],"description":"Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.comments.update","x-executor-toolPath":"drive.comments.update","tags":["Google Drive API"],"description":"Updates a comment with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments/{commentId}/replies":{"get":{"operationId":"drive.replies.list","x-executor-toolPath":"drive.replies.list","tags":["Google Drive API"],"description":"Lists a comment's replies. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to include deleted replies. Deleted replies don't include their original content.","schema":{"description":"Whether to include deleted replies. Deleted replies don't include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of replies to return. The service may return fewer than this value. If unspecified, at most 20 replies will be returned. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ReplyList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.replies.create","x-executor-toolPath":"drive.replies.create","tags":["Google Drive API"],"description":"Creates a reply to a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/comments/{commentId}/replies/{replyId}":{"get":{"operationId":"drive.replies.get","x-executor-toolPath":"drive.replies.get","tags":["Google Drive API"],"description":"Gets a reply by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"replyId","in":"path","required":true,"description":"The ID of the reply.","schema":{"description":"The ID of the reply.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeDeleted","in":"query","required":false,"description":"Whether to return deleted replies. Deleted replies don't include their original content.","schema":{"description":"Whether to return deleted replies. Deleted replies don't include their original content.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.replies.delete","x-executor-toolPath":"drive.replies.delete","tags":["Google Drive API"],"description":"Deletes a reply. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"replyId","in":"path","required":true,"description":"The ID of the reply.","schema":{"description":"The ID of the reply.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.replies.update","x-executor-toolPath":"drive.replies.update","tags":["Google Drive API"],"description":"Updates a reply with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"commentId","in":"path","required":true,"description":"The ID of the comment.","schema":{"description":"The ID of the comment.","type":"string"}},{"name":"replyId","in":"path","required":true,"description":"The ID of the reply.","schema":{"description":"The ID of the reply.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Reply"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/copy":{"post":{"operationId":"drive.files.copy","x-executor-toolPath":"drive.files.copy","tags":["Google Drive API"],"description":"Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"copyComments","in":"query","required":false,"description":"Whether to copy the open (unresolved) comments associated with the file.","schema":{"description":"Whether to copy the open (unresolved) comments associated with the file.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.","schema":{"description":"Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"ignoreDefaultVisibility","in":"query","required":false,"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","schema":{"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/download":{"post":{"operationId":"drive.files.download","x-executor-toolPath":"drive.files.download","tags":["Google Drive API"],"description":"Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.","parameters":[{"name":"fileId","in":"path","required":true,"description":"Required. The ID of the file to download.","schema":{"description":"Required. The ID of the file to download.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mimeType","in":"query","required":false,"description":"Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.","schema":{"description":"Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"revisionId","in":"query","required":false,"description":"Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.","schema":{"description":"Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/export":{"get":{"operationId":"drive.files.export","x-executor-toolPath":"drive.files.export","tags":["Google Drive API"],"description":"Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mimeType","in":"query","required":true,"description":"Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).","schema":{"description":"Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/listLabels":{"get":{"operationId":"drive.files.listLabels","x-executor-toolPath":"drive.files.listLabels","tags":["Google Drive API"],"description":"Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID for the file.","schema":{"description":"The ID for the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of labels to return per page. When not set, defaults to 100.","schema":{"description":"The maximum number of labels to return per page. When not set, defaults to 100.","format":"int32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_LabelList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/modifyLabels":{"post":{"operationId":"drive.files.modifyLabels","x-executor-toolPath":"drive.files.modifyLabels","tags":["Google Drive API"],"description":"Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file to which the labels belong.","schema":{"description":"The ID of the file to which the labels belong.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ModifyLabelsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_ModifyLabelsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/permissions":{"get":{"operationId":"drive.permissions.list","x-executor-toolPath":"drive.permissions.list","tags":["Google Drive API"],"description":"Lists a file's or shared drive's permissions. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100.","schema":{"description":"The maximum number of permissions to return. The service may return fewer than this value. If unspecified, at most 100 permissions will be returned for shared drives, and the entire list of permissions for non-shared drives. The maximum value is 100; values above 100 will be coerced to 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_PermissionList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.permissions.create","x-executor-toolPath":"drive.permissions.create","tags":["Google Drive API"],"description":"Creates a permission for a file or shared drive. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"emailMessage","in":"query","required":false,"description":"A plain text custom message to include in the notification email.","schema":{"description":"A plain text custom message to include in the notification email.","type":"string"},"style":"form","explode":false},{"name":"enforceExpansiveAccess","in":"query","required":false,"description":"Deprecated: All requests use the expansive access rules.","schema":{"description":"Deprecated: All requests use the expansive access rules.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: See `moveToNewOwnersRoot` for details.","schema":{"description":"Deprecated: See `moveToNewOwnersRoot` for details.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"moveToNewOwnersRoot","in":"query","required":false,"description":"This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed.","schema":{"description":"This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents aren't changed.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sendNotificationEmail","in":"query","required":false,"description":"Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.","schema":{"description":"Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.","type":"boolean"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"transferOwnership","in":"query","required":false,"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file).","schema":{"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com/workspace/drive/api/guides/transfer-file).","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/permissions/{permissionId}":{"get":{"operationId":"drive.permissions.get","x-executor-toolPath":"drive.permissions.get","tags":["Google Drive API"],"description":"Gets a permission by ID. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"permissionId","in":"path","required":true,"description":"The ID of the permission.","schema":{"description":"The ID of the permission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.permissions.delete","x-executor-toolPath":"drive.permissions.delete","tags":["Google Drive API"],"description":"Deletes a permission. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"permissionId","in":"path","required":true,"description":"The ID of the permission.","schema":{"description":"The ID of the permission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceExpansiveAccess","in":"query","required":false,"description":"Deprecated: All requests use the expansive access rules.","schema":{"description":"Deprecated: All requests use the expansive access rules.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.permissions.update","x-executor-toolPath":"drive.permissions.update","tags":["Google Drive API"],"description":"Updates a permission with patch semantics. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file or shared drive.","schema":{"description":"The ID of the file or shared drive.","type":"string"}},{"name":"permissionId","in":"path","required":true,"description":"The ID of the permission.","schema":{"description":"The ID of the permission.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceExpansiveAccess","in":"query","required":false,"description":"Deprecated: All requests use the expansive access rules.","schema":{"description":"Deprecated: All requests use the expansive access rules.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"removeExpiration","in":"query","required":false,"description":"Whether to remove the expiration date.","schema":{"description":"Whether to remove the expiration date.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"transferOwnership","in":"query","required":false,"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com//workspace/drive/api/guides/transfer-file).","schema":{"description":"Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see [Transfer file ownership](https://developers.google.com//workspace/drive/api/guides/transfer-file).","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","schema":{"description":"Issue the request as a domain administrator. If set to `true`, and if the following additional conditions are met, the requester is granted access: 1. The file ID parameter refers to a shared drive. 2. The requester is an administrator of the domain to which the shared drive belongs. For more information, see [Manage shared drives as domain administrators](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives#manage-administrators).","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Permission"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/revisions":{"get":{"operationId":"drive.revisions.list","x-executor-toolPath":"drive.revisions.list","tags":["Google Drive API"],"description":"Lists a file's revisions. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions). **Important:** The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API.","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","schema":{"description":"The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 200 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.","format":"int32","default":200,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","schema":{"description":"The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_RevisionList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/revisions/{revisionId}":{"get":{"operationId":"drive.revisions.get","x-executor-toolPath":"drive.revisions.get","tags":["Google Drive API"],"description":"Gets a revision's metadata or content by ID. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"revisionId","in":"path","required":true,"description":"The ID of the revision.","schema":{"description":"The ID of the revision.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"acknowledgeAbuse","in":"query","required":false,"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","schema":{"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Revision"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.revisions.delete","x-executor-toolPath":"drive.revisions.delete","tags":["Google Drive API"],"description":"Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see [Manage file revisions](https://developers.google.com/drive/api/guides/manage-revisions).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"revisionId","in":"path","required":true,"description":"The ID of the revision.","schema":{"description":"The ID of the revision.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.revisions.update","x-executor-toolPath":"drive.revisions.update","tags":["Google Drive API"],"description":"Updates a revision with patch semantics. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"revisionId","in":"path","required":true,"description":"The ID of the revision.","schema":{"description":"The ID of the revision.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Revision"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Revision"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"]}},"/files/{fileId}/watch":{"post":{"operationId":"drive.files.watch","x-executor-toolPath":"drive.files.watch","tags":["Google Drive API"],"description":"Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"acknowledgeAbuse","in":"query","required":false,"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","schema":{"description":"Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.photos.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.metadata.readonly","https://www.googleapis.com/auth/drive.photos.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/operations/{name}":{"get":{"operationId":"drive.operations.get","x-executor-toolPath":"drive.operations.get","tags":["Google Drive API"],"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","parameters":[{"name":"name","in":"path","required":true,"description":"The name of the operation resource.","schema":{"description":"The name of the operation resource.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_Operation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.meet.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.meet.readonly","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]}},"/teamdrives":{"get":{"operationId":"drive.teamdrives.list","x-executor-toolPath":"drive.teamdrives.list","tags":["Google Drive API"],"description":"Deprecated: Use `drives.list` instead.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of Team Drives to return.","schema":{"description":"Maximum number of Team Drives to return.","format":"int32","default":10,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token for Team Drives.","schema":{"description":"Page token for Team Drives.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Query string for searching Team Drives.","schema":{"description":"Query string for searching Team Drives.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.","schema":{"description":"Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDriveList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"post":{"operationId":"drive.teamdrives.create","x-executor-toolPath":"drive.teamdrives.create","tags":["Google Drive API"],"description":"Deprecated: Use `drives.create` instead.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestId","in":"query","required":true,"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.","schema":{"description":"Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/teamdrives/{teamDriveId}":{"get":{"operationId":"drive.teamdrives.get","x-executor-toolPath":"drive.teamdrives.get","tags":["Google Drive API"],"description":"Deprecated: Use `drives.get` instead.","parameters":[{"name":"teamDriveId","in":"path","required":true,"description":"The ID of the Team Drive","schema":{"description":"The ID of the Team Drive","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive"]},"delete":{"operationId":"drive.teamdrives.delete","x-executor-toolPath":"drive.teamdrives.delete","tags":["Google Drive API"],"description":"Deprecated: Use `drives.delete` instead.","parameters":[{"name":"teamDriveId","in":"path","required":true,"description":"The ID of the Team Drive","schema":{"description":"The ID of the Team Drive","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]},"patch":{"operationId":"drive.teamdrives.update","x-executor-toolPath":"drive.teamdrives.update","tags":["Google Drive API"],"description":"Deprecated: Use `drives.update` instead.","parameters":[{"name":"teamDriveId","in":"path","required":true,"description":"The ID of the Team Drive","schema":{"description":"The ID of the Team Drive","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useDomainAdminAccess","in":"query","required":false,"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","schema":{"description":"Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive"]}},"/upload/drive/v3/files":{"post":{"operationId":"drive.files.createMedia","x-executor-toolPath":"drive.files.createMedia","tags":["Google Drive API"],"description":"Creates a file. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Creating files in multiple folders is no longer supported.","schema":{"description":"Deprecated: Creating files in multiple folders is no longer supported.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"ignoreDefaultVisibility","in":"query","required":false,"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","schema":{"description":"Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive"],"servers":[{"url":"https://www.googleapis.com/"}]}},"/upload/drive/v3/files/{fileId}":{"patch":{"operationId":"drive.files.updateMedia","x-executor-toolPath":"drive.files.updateMedia","tags":["Google Drive API"],"description":"Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](https://developers.google.com/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](https://developers.google.com/workspace/drive/api/guides/manage-uploads). (media upload)","parameters":[{"name":"fileId","in":"path","required":true,"description":"The ID of the file.","schema":{"description":"The ID of the file.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"addParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to add.","schema":{"description":"A comma-separated list of parent IDs to add.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"enforceSingleParent","in":"query","required":false,"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","schema":{"description":"Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeLabels","in":"query","required":false,"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","schema":{"description":"A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.","type":"string"},"style":"form","explode":false},{"name":"includePermissionsForView","in":"query","required":false,"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","schema":{"description":"Specifies which additional view's permissions to include in the response. Only `published` is supported.","type":"string"},"style":"form","explode":false},{"name":"keepRevisionForever","in":"query","required":false,"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","schema":{"description":"Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"ocrLanguage","in":"query","required":false,"description":"A language hint for OCR processing during image import (ISO 639-1 code).","schema":{"description":"A language hint for OCR processing during image import (ISO 639-1 code).","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"removeParents","in":"query","required":false,"description":"A comma-separated list of parent IDs to remove.","schema":{"description":"A comma-separated list of parent IDs to remove.","type":"string"},"style":"form","explode":false},{"name":"supportsAllDrives","in":"query","required":false,"description":"Whether the requesting application supports both My Drives and shared drives.","schema":{"description":"Whether the requesting application supports both My Drives and shared drives.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"supportsTeamDrives","in":"query","required":false,"description":"Deprecated: Use `supportsAllDrives` instead.","schema":{"description":"Deprecated: Use `supportsAllDrives` instead.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"useContentAsIndexableText","in":"query","required":false,"description":"Whether to use the uploaded content as indexable text.","schema":{"description":"Whether to use the uploaded content as indexable text.","default":false,"type":"boolean"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/drive_v3_File"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/drive.appdata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.scripts"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive"]}],"x-google-scopes":["https://www.googleapis.com/auth/drive.appdata","https://www.googleapis.com/auth/drive.file","https://www.googleapis.com/auth/drive.metadata","https://www.googleapis.com/auth/drive.scripts","https://www.googleapis.com/auth/drive"],"servers":[{"url":"https://www.googleapis.com/"}]}}},"components":{"schemas":{"drive_v3_About":{"description":"Information about the user, the user's Drive, and system capabilities.","type":"object","properties":{"appInstalled":{"description":"Whether the user has installed the requesting app.","type":"boolean"},"canCreateDrives":{"description":"Whether the user can create shared drives.","type":"boolean"},"canCreateTeamDrives":{"description":"Deprecated: Use `canCreateDrives` instead.","type":"boolean"},"driveThemes":{"description":"A list of themes that are supported for shared drives.","type":"array","items":{"type":"object","properties":{"backgroundImageLink":{"description":"A link to this theme's background image.","type":"string"},"colorRgb":{"description":"The color of this theme as an RGB hex string.","type":"string"},"id":{"description":"The ID of the theme.","type":"string"}}}},"exportFormats":{"description":"A map of source MIME type to possible targets for all supported exports.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"folderColorPalette":{"description":"The currently supported folder colors as RGB hex strings.","type":"array","items":{"type":"string"}},"importFormats":{"description":"A map of source MIME type to possible targets for all supported imports.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#about\"`.","default":"drive#about","type":"string"},"maxImportSizes":{"description":"A map of maximum import sizes by MIME type, in bytes.","type":"object","additionalProperties":{"format":"int64","type":"string"}},"maxUploadSize":{"description":"The maximum upload size in bytes.","format":"int64","type":"string"},"storageQuota":{"description":"The user's storage quota limits and usage. For users that are part of an organization with pooled storage, information about the limit and usage across all services is for the organization, rather than the individual user. All fields are measured in bytes.","type":"object","properties":{"limit":{"description":"The usage limit, if applicable. This will not be present if the user has unlimited storage. For users that are part of an organization with pooled storage, this is the limit for the organization, rather than the individual user.","format":"int64","type":"string"},"usage":{"description":"The total usage across all services. For users that are part of an organization with pooled storage, this is the usage across all services for the organization, rather than the individual user.","format":"int64","type":"string"},"usageInDrive":{"description":"The usage by all files in Google Drive.","format":"int64","type":"string"},"usageInDriveTrash":{"description":"The usage by trashed files in Google Drive.","format":"int64","type":"string"}}},"teamDriveThemes":{"description":"Deprecated: Use `driveThemes` instead.","type":"array","items":{"type":"object","properties":{"backgroundImageLink":{"description":"Deprecated: Use `driveThemes/backgroundImageLink` instead.","type":"string"},"colorRgb":{"description":"Deprecated: Use `driveThemes/colorRgb` instead.","type":"string"},"id":{"description":"Deprecated: Use `driveThemes/id` instead.","type":"string"}}}},"user":{"$ref":"#/components/schemas/drive_v3_User"}}},"drive_v3_AccessProposal":{"description":"Manage outstanding access proposals on a file.","type":"object","properties":{"createTime":{"description":"The creation time.","format":"google-datetime","type":"string"},"fileId":{"description":"The file ID that the proposal for access is on.","type":"string"},"proposalId":{"description":"The ID of the access proposal.","type":"string"},"recipientEmailAddress":{"description":"The email address of the user that will receive permissions, if accepted.","type":"string"},"requestMessage":{"description":"The message that the requester added to the proposal.","type":"string"},"requesterEmailAddress":{"description":"The email address of the requesting user.","type":"string"},"rolesAndViews":{"description":"A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AccessProposalRoleAndView"}}}},"drive_v3_AccessProposalRoleAndView":{"description":"A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"object","properties":{"role":{"description":"The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`","type":"string"},"view":{"description":"Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.","type":"string"}}},"drive_v3_AddReviewer":{"description":"Representation of a reviewer addition.","type":"object","properties":{"addedReviewerEmail":{"description":"Required. The email of the reviewer to add.","type":"string"}}},"drive_v3_App":{"description":"The `apps` resource provides a list of apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details. Some resource methods (such as `apps.get`) require an `appId`. Use the `apps.list` method to retrieve the ID for an installed application.","type":"object","properties":{"authorized":{"description":"Whether the app is authorized to access data on the user's Drive.","type":"boolean"},"createInFolderTemplate":{"description":"The template URL to create a file with this app in a given folder. The template contains the {folderId} to be replaced by the folder ID house the new file.","type":"string"},"createUrl":{"description":"The URL to create a file with this app.","type":"string"},"hasDriveWideScope":{"description":"Whether the app has Drive-wide scope. An app with Drive-wide scope can access all files in the user's Drive.","type":"boolean"},"icons":{"description":"The various icons for the app.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AppIcons"}},"id":{"description":"The ID of the app.","type":"string"},"installed":{"description":"Whether the app is installed.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#app\".","default":"drive#app","type":"string"},"longDescription":{"description":"A long description of the app.","type":"string"},"name":{"description":"The name of the app.","type":"string"},"objectType":{"description":"The type of object this app creates such as a Chart. If empty, the app name should be used instead.","type":"string"},"openUrlTemplate":{"description":"The template URL for opening files with this app. The template contains {ids} or {exportIds} to be replaced by the actual file IDs. For more information, see Open Files for the full documentation.","type":"string"},"primaryFileExtensions":{"description":"The list of primary file extensions.","type":"array","items":{"type":"string"}},"primaryMimeTypes":{"description":"The list of primary MIME types.","type":"array","items":{"type":"string"}},"productId":{"description":"The ID of the product listing for this app.","type":"string"},"productUrl":{"description":"A link to the product listing for this app.","type":"string"},"secondaryFileExtensions":{"description":"The list of secondary file extensions.","type":"array","items":{"type":"string"}},"secondaryMimeTypes":{"description":"The list of secondary MIME types.","type":"array","items":{"type":"string"}},"shortDescription":{"description":"A short description of the app.","type":"string"},"supportsCreate":{"description":"Whether this app supports creating objects.","type":"boolean"},"supportsImport":{"description":"Whether this app supports importing from Google Docs.","type":"boolean"},"supportsMultiOpen":{"description":"Whether this app supports opening more than one file.","type":"boolean"},"supportsOfflineCreate":{"description":"Whether this app supports creating files when offline.","type":"boolean"},"useByDefault":{"description":"Whether the app is selected as the default handler for the types it supports.","type":"boolean"}}},"drive_v3_AppIcons":{"type":"object","properties":{"category":{"description":"Category of the icon. Allowed values are: * `application` - The icon for the application. * `document` - The icon for a file associated with the app. * `documentShared` - The icon for a shared file associated with the app.","type":"string"},"iconUrl":{"description":"URL for the icon.","type":"string"},"size":{"description":"Size of the icon. Represented as the maximum of the width and height.","format":"int32","type":"integer"}}},"drive_v3_AppList":{"description":"A list of third-party applications which the user has installed or given access to Google Drive.","type":"object","properties":{"defaultAppIds":{"description":"The list of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).","type":"array","items":{"type":"string"}},"items":{"description":"The list of apps.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_App"}},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string \"drive#appList\".","default":"drive#appList","type":"string"},"selfLink":{"description":"A link back to this list.","type":"string"}}},"drive_v3_Approval":{"description":"Metadata for an approval. An approval is a review or approve process for a Drive item.","type":"object","properties":{"approvalId":{"description":"The approval ID.","type":"string"},"completeTime":{"description":"Output only. The time the approval was completed.","format":"google-datetime","readOnly":true,"type":"string"},"createTime":{"description":"Output only. The time the approval was created.","format":"google-datetime","readOnly":true,"type":"string"},"dueTime":{"description":"The time that the approval is due.","format":"google-datetime","type":"string"},"fileContentChangeBehavior":{"description":"Output only. The behavior of the approval when the file content changes.","readOnly":true,"enum":["FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED","RESET_APPROVAL","NO_APPROVAL_ACTION"],"type":"string"},"initiator":{"$ref":"#/components/schemas/drive_v3_User"},"kind":{"description":"This is always drive#approval.","type":"string"},"modifyTime":{"description":"Output only. The most recent time the approval was modified.","format":"google-datetime","readOnly":true,"type":"string"},"reviewerResponses":{"description":"The responses made on the approval by reviewers.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_ReviewerResponse"}},"status":{"description":"Output only. The status of the approval at the time this resource was requested.","readOnly":true,"enum":["STATUS_UNSPECIFIED","IN_PROGRESS","APPROVED","CANCELLED","DECLINED"],"type":"string"},"targetFileId":{"description":"Target file id of the approval.","type":"string"}}},"drive_v3_ApprovalList":{"description":"The response of an approvals list request.","type":"object","properties":{"items":{"description":"The list of approvals. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Approval"}},"kind":{"description":"This is always drive#approvalList","type":"string"},"nextPageToken":{"description":"The page token for the next page of approvals. This is absent if the end of the approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.","type":"string"}}},"drive_v3_ApproveApprovalRequest":{"description":"Request for approving an approval as a reviewer.","type":"object","properties":{"message":{"description":"Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_CancelApprovalRequest":{"description":"Request for cancelling an approval as an initiator.","type":"object","properties":{"message":{"description":"Optional. A message to accompany the cancellation of the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_Change":{"description":"A change to a file or shared drive.","type":"object","properties":{"changeType":{"description":"The type of the change. Possible values are `file` and `drive`.","type":"string"},"drive":{"$ref":"#/components/schemas/drive_v3_Drive"},"driveId":{"description":"The ID of the shared drive associated with this change.","type":"string"},"file":{"$ref":"#/components/schemas/drive_v3_File"},"fileId":{"description":"The ID of the file which has changed.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#change\"`.","default":"drive#change","type":"string"},"removed":{"description":"Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.","type":"boolean"},"teamDrive":{"$ref":"#/components/schemas/drive_v3_TeamDrive"},"teamDriveId":{"description":"Deprecated: Use `driveId` instead.","type":"string"},"time":{"description":"The time of this change (RFC 3339 date-time).","format":"date-time","type":"string"},"type":{"description":"Deprecated: Use `changeType` instead.","type":"string"}}},"drive_v3_ChangeList":{"description":"A list of changes for a user.","type":"object","properties":{"changes":{"description":"The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Change"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#changeList\"`.","default":"drive#changeList","type":"string"},"newStartPageToken":{"description":"The starting page token for future changes. This will be present only if the end of the current changes list has been reached. The page token doesn't expire.","type":"string"},"nextPageToken":{"description":"The page token for the next page of changes. This will be absent if the end of the changes list has been reached. The page token doesn't expire.","type":"string"}}},"drive_v3_Channel":{"description":"A notification channel used to watch for resource changes.","type":"object","properties":{"address":{"description":"The address where notifications are delivered for this channel.","type":"string"},"expiration":{"description":"Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.","format":"int64","type":"string"},"id":{"description":"A UUID or similar unique string that identifies this channel.","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"},"params":{"description":"Additional parameters controlling delivery channel behavior. Optional.","type":"object","additionalProperties":{"type":"string"}},"payload":{"description":"A Boolean value to indicate whether payload is wanted. Optional.","type":"boolean"},"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"},"token":{"description":"An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.","type":"string"},"type":{"description":"The type of delivery mechanism used for this channel. Valid values are \"web_hook\" or \"webhook\".","type":"string"}}},"drive_v3_ClientEncryptionDetails":{"description":"Details about the client-side encryption applied to the file.","type":"object","properties":{"decryptionMetadata":{"$ref":"#/components/schemas/drive_v3_DecryptionMetadata"},"encryptionState":{"description":"The encryption state of the file. The values expected here are: - encrypted - unencrypted ","type":"string"}}},"drive_v3_Comment":{"description":"A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.","type":"object","properties":{"anchor":{"description":"A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).","type":"string"},"assigneeEmailAddress":{"description":"Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.","readOnly":true,"type":"string"},"author":{"$ref":"#/components/schemas/drive_v3_User"},"content":{"description":"The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.","type":"string"},"createdTime":{"description":"The time at which the comment was created (RFC 3339 date-time).","format":"date-time","type":"string"},"deleted":{"description":"Output only. Whether the comment has been deleted. A deleted comment has no content.","type":"boolean"},"htmlContent":{"description":"Output only. The content of the comment with HTML formatting.","type":"string"},"id":{"description":"Output only. The ID of the comment.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.","default":"drive#comment","type":"string"},"mentionedEmailAddresses":{"description":"Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.","readOnly":true,"type":"array","items":{"type":"string"}},"modifiedTime":{"description":"The last time the comment or any of its replies was modified (RFC 3339 date-time).","format":"date-time","type":"string"},"quotedFileContent":{"description":"The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.","type":"object","properties":{"mimeType":{"description":"The MIME type of the quoted content.","type":"string"},"value":{"description":"The quoted content itself. This is interpreted as plain text if set through the API.","type":"string"}}},"replies":{"description":"Output only. The full list of replies to the comment in chronological order.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Reply"}},"resolved":{"description":"Output only. Whether the comment has been resolved by one of its replies.","type":"boolean"}}},"drive_v3_CommentApprovalRequest":{"description":"Request for commenting on an approval.","type":"object","properties":{"message":{"description":"Required. A message to comment on the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_CommentList":{"description":"A list of comments on a file.","type":"object","properties":{"comments":{"description":"The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Comment"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#commentList\"`.","default":"drive#commentList","type":"string"},"nextPageToken":{"description":"The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_ContentRestriction":{"description":"A restriction for accessing the content of the file.","type":"object","properties":{"ownerRestricted":{"description":"Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.","type":"boolean"},"readOnly":{"description":"Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.","type":"boolean"},"reason":{"description":"Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.","type":"string"},"restrictingUser":{"$ref":"#/components/schemas/drive_v3_User"},"restrictionTime":{"description":"The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.","format":"date-time","type":"string"},"systemRestricted":{"description":"Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.","type":"boolean"},"type":{"description":"Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.","type":"string"}}},"drive_v3_DeclineApprovalRequest":{"description":"Request for declining an approval as a reviewer.","type":"object","properties":{"message":{"description":"Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.","type":"string"}}},"drive_v3_DecryptionMetadata":{"description":"Representation of the CSE DecryptionMetadata.","type":"object","properties":{"aes256GcmChunkSize":{"description":"Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small ","type":"string"},"encryptionResourceKeyHash":{"description":"The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference","type":"string"},"jwt":{"description":"The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file.","type":"string"},"kaclsId":{"description":"The ID of the KACLS (Key ACL Service) used to encrypt the file.","format":"int64","type":"string"},"kaclsName":{"description":"The name of the KACLS (Key ACL Service) used to encrypt the file.","type":"string"},"keyFormat":{"description":"Key format for the unwrapped key. Must be `tinkAesGcmKey`.","type":"string"},"wrappedKey":{"description":"The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file.","type":"string"}}},"drive_v3_DownloadRestriction":{"description":"A restriction for copy and download of the file.","type":"object","properties":{"restrictedForReaders":{"description":"Whether download and copy is restricted for readers.","type":"boolean"},"restrictedForWriters":{"description":"Whether download and copy is restricted for writers. If true, download is also restricted for readers.","type":"boolean"}}},"drive_v3_DownloadRestrictionsMetadata":{"description":"Download restrictions applied to the file.","type":"object","properties":{"effectiveDownloadRestrictionWithContext":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"},"itemDownloadRestriction":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"}}},"drive_v3_Drive":{"description":"Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.","type":"object","properties":{"backgroundImageFile":{"description":"An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.","type":"object","properties":{"id":{"description":"The ID of an image file in Google Drive to use for the background image.","type":"string"},"width":{"description":"The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.","format":"float","type":"number"},"xCoordinate":{"description":"The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.","format":"float","type":"number"},"yCoordinate":{"description":"The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.","format":"float","type":"number"}}},"backgroundImageLink":{"description":"Output only. A short-lived link to this shared drive's background image.","type":"string"},"capabilities":{"description":"Output only. Capabilities the current user has on this shared drive.","type":"object","properties":{"canAddChildren":{"description":"Output only. Whether the current user can add children to folders in this shared drive.","type":"boolean"},"canChangeCopyRequiresWriterPermissionRestriction":{"description":"Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.","type":"boolean"},"canChangeDomainUsersOnlyRestriction":{"description":"Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.","type":"boolean"},"canChangeDownloadRestriction":{"description":"Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.","type":"boolean"},"canChangeDriveBackground":{"description":"Output only. Whether the current user can change the background of this shared drive.","type":"boolean"},"canChangeDriveMembersOnlyRestriction":{"description":"Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.","type":"boolean"},"canChangeSharingFoldersRequiresOrganizerPermissionRestriction":{"description":"Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.","type":"boolean"},"canComment":{"description":"Output only. Whether the current user can comment on files in this shared drive.","type":"boolean"},"canCopy":{"description":"Output only. Whether the current user can copy files in this shared drive.","type":"boolean"},"canDeleteChildren":{"description":"Output only. Whether the current user can delete children from folders in this shared drive.","type":"boolean"},"canDeleteDrive":{"description":"Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.","type":"boolean"},"canDownload":{"description":"Output only. Whether the current user can download files in this shared drive.","type":"boolean"},"canEdit":{"description":"Output only. Whether the current user can edit files in this shared drive","type":"boolean"},"canListChildren":{"description":"Output only. Whether the current user can list the children of folders in this shared drive.","type":"boolean"},"canManageMembers":{"description":"Output only. Whether the current user can add members to this shared drive or remove them or change their role.","type":"boolean"},"canReadRevisions":{"description":"Output only. Whether the current user can read the revisions resource of files in this shared drive.","type":"boolean"},"canRename":{"description":"Output only. Whether the current user can rename files or folders in this shared drive.","type":"boolean"},"canRenameDrive":{"description":"Output only. Whether the current user can rename this shared drive.","type":"boolean"},"canResetDriveRestrictions":{"description":"Output only. Whether the current user can reset the shared drive restrictions to defaults.","type":"boolean"},"canShare":{"description":"Output only. Whether the current user can share files or folders in this shared drive.","type":"boolean"},"canTrashChildren":{"description":"Output only. Whether the current user can trash children from folders in this shared drive.","type":"boolean"}}},"colorRgb":{"description":"The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.","type":"string"},"createdTime":{"description":"The time at which the shared drive was created (RFC 3339 date-time).","format":"date-time","type":"string"},"hidden":{"description":"Whether the shared drive is hidden from default view.","type":"boolean"},"id":{"description":"Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#drive\"`.","default":"drive#drive","type":"string"},"name":{"description":"The name of this shared drive.","type":"string"},"orgUnitId":{"description":"Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.","type":"string"},"restrictions":{"description":"A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.","type":"object","properties":{"adminManagedRestrictions":{"description":"Whether administrative privileges on this shared drive are required to modify restrictions.","type":"boolean"},"copyRequiresWriterPermission":{"description":"Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.","type":"boolean"},"domainUsersOnly":{"description":"Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.","type":"boolean"},"downloadRestriction":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"},"driveMembersOnly":{"description":"Whether access to items inside this shared drive is restricted to its members.","type":"boolean"},"sharingFoldersRequiresOrganizerPermission":{"description":"If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.","type":"boolean"}}},"themeId":{"description":"The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.","type":"string"}}},"drive_v3_DriveList":{"description":"A list of shared drives.","type":"object","properties":{"drives":{"description":"The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Drive"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#driveList\"`.","default":"drive#driveList","type":"string"},"nextPageToken":{"description":"The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_File":{"description":"The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.","type":"object","properties":{"appProperties":{"description":"A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.","type":"object","additionalProperties":{"type":"string"}},"capabilities":{"description":"Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).","type":"object","properties":{"canAcceptOwnership":{"description":"Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.","type":"boolean"},"canAccessViaGenAi":{"description":"Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility).","type":"boolean"},"canAddChildren":{"description":"Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.","type":"boolean"},"canAddFolderFromAnotherDrive":{"description":"Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canAddMyDriveParent":{"description":"Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.","type":"boolean"},"canChangeCopyRequiresWriterPermission":{"description":"Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.","type":"boolean"},"canChangeItemDownloadRestriction":{"description":"Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.","type":"boolean"},"canChangeSecurityUpdateEnabled":{"description":"Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.","type":"boolean"},"canChangeViewersCanCopyContent":{"description":"Deprecated: Output only.","type":"boolean"},"canComment":{"description":"Output only. Whether the current user can comment on this file.","type":"boolean"},"canCopy":{"description":"Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder.","type":"boolean"},"canDelete":{"description":"Output only. Whether the current user can delete this file.","type":"boolean"},"canDeleteChildren":{"description":"Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canDisableInheritedPermissions":{"description":"Whether a user can disable inherited permissions.","type":"boolean"},"canDownload":{"description":"Output only. Whether the current user can download this file.","type":"boolean"},"canEdit":{"description":"Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.","type":"boolean"},"canEnableInheritedPermissions":{"description":"Whether a user can re-enable inherited permissions.","type":"boolean"},"canListChildren":{"description":"Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.","type":"boolean"},"canModifyContent":{"description":"Output only. Whether the current user can modify the content of this file.","type":"boolean"},"canModifyContentRestriction":{"description":"Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.","type":"boolean"},"canModifyEditorContentRestriction":{"description":"Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.","type":"boolean"},"canModifyLabels":{"description":"Output only. Whether the current user can modify the labels on the file.","type":"boolean"},"canModifyOwnerContentRestriction":{"description":"Output only. Whether the current user can add or modify content restrictions which are owner restricted.","type":"boolean"},"canMoveChildrenOutOfDrive":{"description":"Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canMoveChildrenOutOfTeamDrive":{"description":"Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.","type":"boolean"},"canMoveChildrenWithinDrive":{"description":"Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.","type":"boolean"},"canMoveChildrenWithinTeamDrive":{"description":"Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.","type":"boolean"},"canMoveItemIntoTeamDrive":{"description":"Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.","type":"boolean"},"canMoveItemOutOfDrive":{"description":"Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added.","type":"boolean"},"canMoveItemOutOfTeamDrive":{"description":"Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.","type":"boolean"},"canMoveItemWithinDrive":{"description":"Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.","type":"boolean"},"canMoveItemWithinTeamDrive":{"description":"Deprecated: Output only. Use `canMoveItemWithinDrive` instead.","type":"boolean"},"canMoveTeamDriveItem":{"description":"Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.","type":"boolean"},"canReadDrive":{"description":"Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.","type":"boolean"},"canReadLabels":{"description":"Output only. Whether the current user can read the labels on the file.","type":"boolean"},"canReadRevisions":{"description":"Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read.","type":"boolean"},"canReadTeamDrive":{"description":"Deprecated: Output only. Use `canReadDrive` instead.","type":"boolean"},"canRemoveChildren":{"description":"Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.","type":"boolean"},"canRemoveContentRestriction":{"description":"Output only. Whether there's a content restriction on the file that can be removed by the current user.","type":"boolean"},"canRemoveMyDriveParent":{"description":"Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.","type":"boolean"},"canRename":{"description":"Output only. Whether the current user can rename this file.","type":"boolean"},"canShare":{"description":"Output only. Whether the current user can modify the sharing settings for this file.","type":"boolean"},"canStartApproval":{"description":"Whether the current user can start an approval on the file.","type":"boolean"},"canTrash":{"description":"Output only. Whether the current user can move this file to trash.","type":"boolean"},"canTrashChildren":{"description":"Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.","type":"boolean"},"canUntrash":{"description":"Output only. Whether the current user can restore this file from trash.","type":"boolean"}}},"clientEncryptionDetails":{"$ref":"#/components/schemas/drive_v3_ClientEncryptionDetails"},"contentHints":{"description":"Additional information about the content of the file. These fields are never populated in responses.","type":"object","properties":{"indexableText":{"description":"Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.","type":"string"},"thumbnail":{"description":"A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.","type":"object","properties":{"image":{"description":"The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).","format":"byte","type":"string"},"mimeType":{"description":"The MIME type of the thumbnail.","type":"string"}}}}},"contentRestrictions":{"description":"Restrictions for accessing the content of the file. Only populated if such a restriction exists.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_ContentRestriction"}},"copyRequiresWriterPermission":{"description":"Whether the options to copy, print, or download this file should be disabled for readers and commenters.","type":"boolean"},"createdTime":{"description":"The time at which the file was created (RFC 3339 date-time).","format":"date-time","type":"string"},"description":{"description":"A short description of the file.","type":"string"},"downloadRestrictions":{"$ref":"#/components/schemas/drive_v3_DownloadRestrictionsMetadata"},"driveId":{"description":"Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.","type":"string"},"explicitlyTrashed":{"description":"Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.","type":"boolean"},"exportLinks":{"description":"Output only. Links for exporting Docs Editors files to specific formats.","readOnly":true,"type":"object","additionalProperties":{"type":"string"}},"fileExtension":{"description":"Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.","type":"string"},"folderColorRgb":{"description":"The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.","type":"string"},"fullFileExtension":{"description":"Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension.","type":"string"},"hasAugmentedPermissions":{"description":"Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.","type":"boolean"},"hasThumbnail":{"description":"Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.","type":"boolean"},"headRevisionId":{"description":"Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.","type":"string"},"iconLink":{"description":"Output only. A static, unauthenticated link to the file's icon.","type":"string"},"id":{"description":"The ID of the file.","type":"string"},"imageMediaMetadata":{"description":"Output only. Additional metadata about image media, if available.","type":"object","properties":{"aperture":{"description":"Output only. The aperture used to create the photo (f-number).","format":"float","type":"number"},"cameraMake":{"description":"Output only. The make of the camera used to create the photo.","type":"string"},"cameraModel":{"description":"Output only. The model of the camera used to create the photo.","type":"string"},"colorSpace":{"description":"Output only. The color space of the photo.","type":"string"},"exposureBias":{"description":"Output only. The exposure bias of the photo (APEX value).","format":"float","type":"number"},"exposureMode":{"description":"Output only. The exposure mode used to create the photo.","type":"string"},"exposureTime":{"description":"Output only. The length of the exposure, in seconds.","format":"float","type":"number"},"flashUsed":{"description":"Output only. Whether a flash was used to create the photo.","type":"boolean"},"focalLength":{"description":"Output only. The focal length used to create the photo, in millimeters.","format":"float","type":"number"},"height":{"description":"Output only. The height of the image in pixels.","format":"int32","type":"integer"},"isoSpeed":{"description":"Output only. The ISO speed used to create the photo.","format":"int32","type":"integer"},"lens":{"description":"Output only. The lens used to create the photo.","type":"string"},"location":{"description":"Output only. Geographic location information stored in the image.","type":"object","properties":{"altitude":{"description":"Output only. The altitude stored in the image.","format":"double","type":"number"},"latitude":{"description":"Output only. The latitude stored in the image.","format":"double","type":"number"},"longitude":{"description":"Output only. The longitude stored in the image.","format":"double","type":"number"}}},"maxApertureValue":{"description":"Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).","format":"float","type":"number"},"meteringMode":{"description":"Output only. The metering mode used to create the photo.","type":"string"},"rotation":{"description":"Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.","format":"int32","type":"integer"},"sensor":{"description":"Output only. The type of sensor used to create the photo.","type":"string"},"subjectDistance":{"description":"Output only. The distance to the subject of the photo, in meters.","format":"int32","type":"integer"},"time":{"description":"Output only. The date and time the photo was taken (EXIF DateTime).","type":"string"},"whiteBalance":{"description":"Output only. The white balance mode used to create the photo.","type":"string"},"width":{"description":"Output only. The width of the image in pixels.","format":"int32","type":"integer"}}},"inheritedPermissionsDisabled":{"description":"Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.","type":"boolean"},"isAppAuthorized":{"description":"Output only. Whether the file was created or opened by the requesting app.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#file\"`.","default":"drive#file","type":"string"},"labelInfo":{"description":"Label information on the file.","type":"object","properties":{"labels":{"description":"Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Label"}}}},"lastModifyingUser":{"$ref":"#/components/schemas/drive_v3_User"},"linkShareMetadata":{"description":"Contains details about the link URLs that clients are using to refer to this item.","type":"object","properties":{"securityUpdateEligible":{"description":"Output only. Whether the file is eligible for security update.","type":"boolean"},"securityUpdateEnabled":{"description":"Output only. Whether the security update is enabled for this file.","type":"boolean"}}},"md5Checksum":{"description":"Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.","type":"string"},"mimeType":{"description":"The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.","type":"string"},"modifiedByMe":{"description":"Output only. Whether the file has been modified by this user.","type":"boolean"},"modifiedByMeTime":{"description":"The last time the file was modified by the user (RFC 3339 date-time).","format":"date-time","type":"string"},"modifiedTime":{"description":"he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.","format":"date-time","type":"string"},"name":{"description":"The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.","type":"string"},"originalFilename":{"description":"The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive.","type":"string"},"ownedByMe":{"description":"Output only. Whether the user owns the file. Not populated for items in shared drives.","type":"boolean"},"owners":{"description":"Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_User"}},"parents":{"description":"The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.","type":"array","items":{"type":"string"}},"permissionIds":{"description":"Output only. List of permission IDs for users with access to this file.","type":"array","items":{"type":"string"}},"permissions":{"description":"Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Permission"}},"properties":{"description":"A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.","type":"object","additionalProperties":{"type":"string"}},"quotaBytesUsed":{"description":"Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.","format":"int64","type":"string"},"resourceKey":{"description":"Output only. A key needed to access the item via a shared link.","type":"string"},"sha1Checksum":{"description":"Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.","type":"string"},"sha256Checksum":{"description":"Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.","type":"string"},"shared":{"description":"Output only. Whether the file has been shared. Not populated for items in shared drives.","type":"boolean"},"sharedWithMeTime":{"description":"The time at which the file was shared with the user, if applicable (RFC 3339 date-time).","format":"date-time","type":"string"},"sharingUser":{"$ref":"#/components/schemas/drive_v3_User"},"shortcutDetails":{"description":"Information about a shortcut file.","type":"object","properties":{"targetId":{"description":"The ID of the file that this shortcut points to. Can only be set on `files.create` requests.","type":"string"},"targetMimeType":{"description":"Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.","type":"string"},"targetResourceKey":{"description":"Output only. The `resourceKey` for the target file.","type":"string"}}},"size":{"description":"Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.","format":"int64","type":"string"},"spaces":{"description":"Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.","type":"array","items":{"type":"string"}},"starred":{"description":"Whether the user has starred the file.","type":"boolean"},"teamDriveId":{"description":"Deprecated: Output only. Use `driveId` instead.","type":"string"},"thumbnailLink":{"description":"Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.","type":"string"},"thumbnailVersion":{"description":"Output only. The thumbnail version for use in thumbnail cache invalidation.","format":"int64","type":"string"},"trashed":{"description":"Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted.","type":"boolean"},"trashedTime":{"description":"The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.","format":"date-time","type":"string"},"trashingUser":{"$ref":"#/components/schemas/drive_v3_User"},"version":{"description":"Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.","format":"int64","type":"string"},"videoMediaMetadata":{"description":"Output only. Additional metadata about video media. This may not be available immediately upon upload.","type":"object","properties":{"durationMillis":{"description":"Output only. The duration of the video in milliseconds.","format":"int64","type":"string"},"height":{"description":"Output only. The height of the video in pixels.","format":"int32","type":"integer"},"width":{"description":"Output only. The width of the video in pixels.","format":"int32","type":"integer"}}},"viewedByMe":{"description":"Output only. Whether the file has been viewed by this user.","type":"boolean"},"viewedByMeTime":{"description":"The last time the file was viewed by the user (RFC 3339 date-time).","format":"date-time","type":"string"},"viewersCanCopyContent":{"description":"Deprecated: Use `copyRequiresWriterPermission` instead.","type":"boolean"},"webContentLink":{"description":"Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.","type":"string"},"webViewLink":{"description":"Output only. A link for opening the file in a relevant Google editor or viewer in a browser.","type":"string"},"writersCanShare":{"description":"Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.","type":"boolean"}}},"drive_v3_FileList":{"description":"A list of files.","type":"object","properties":{"files":{"description":"The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_File"}},"incompleteSearch":{"description":"Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`.","type":"boolean"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#fileList\"`.","default":"drive#fileList","type":"string"},"nextPageToken":{"description":"The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_GenerateCseTokenResponse":{"description":"JWT and associated metadata used to generate CSE files.","type":"object","properties":{"currentKaclsId":{"description":"The current Key ACL Service (KACLS) ID associated with the JWT.","format":"int64","type":"string"},"currentKaclsName":{"description":"Name of the KACLs that the returned KACLs ID points to.","type":"string"},"fileId":{"description":"The fileId for which the JWT was generated.","type":"string"},"jwt":{"description":"The signed JSON Web Token (JWT) for the file.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#generateCseTokenResponse\"`.","type":"string"}}},"drive_v3_GeneratedIds":{"description":"A list of generated file IDs which can be provided in create requests.","type":"object","properties":{"ids":{"description":"The IDs generated for the requesting user in the specified space.","type":"array","items":{"type":"string"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#generatedIds\"`.","default":"drive#generatedIds","type":"string"},"space":{"description":"The type of file that can be created with these IDs.","type":"string"}}},"drive_v3_Label":{"description":"Representation of label and label fields.","type":"object","properties":{"fields":{"description":"A map of the fields on the label, keyed by the field's ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/drive_v3_LabelField"}},"id":{"description":"The ID of the label.","type":"string"},"kind":{"description":"This is always drive#label","type":"string"},"revisionId":{"description":"The revision ID of the label.","type":"string"}}},"drive_v3_LabelField":{"description":"Representation of field, which is a typed key-value pair.","type":"object","properties":{"dateString":{"description":"Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.","type":"array","items":{"format":"date","type":"string"}},"id":{"description":"The identifier of this label field.","type":"string"},"integer":{"description":"Only present if `valueType` is `integer`.","type":"array","items":{"format":"int64","type":"string"}},"kind":{"description":"This is always drive#labelField.","type":"string"},"selection":{"description":"Only present if `valueType` is `selection`","type":"array","items":{"type":"string"}},"text":{"description":"Only present if `valueType` is `text`.","type":"array","items":{"type":"string"}},"user":{"description":"Only present if `valueType` is `user`.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_User"}},"valueType":{"description":"The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`","type":"string"}}},"drive_v3_LabelFieldModification":{"description":"A modification to a label's field.","type":"object","properties":{"fieldId":{"description":"The ID of the field to be modified.","type":"string"},"kind":{"description":"This is always `\"drive#labelFieldModification\"`.","type":"string"},"setDateValues":{"description":"Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD.","type":"array","items":{"format":"date","type":"string"}},"setIntegerValues":{"description":"Replaces the value of an `integer` field with these new values.","type":"array","items":{"format":"int64","type":"string"}},"setSelectionValues":{"description":"Replaces a `selection` field with these new values.","type":"array","items":{"type":"string"}},"setTextValues":{"description":"Sets the value of a `text` field.","type":"array","items":{"type":"string"}},"setUserValues":{"description":"Replaces a `user` field with these new values. The values must be a valid email addresses.","type":"array","items":{"type":"string"}},"unsetValues":{"description":"Unsets the values for this field.","type":"boolean"}}},"drive_v3_LabelList":{"description":"A list of labels applied to a file.","type":"object","properties":{"kind":{"description":"This is always `\"drive#labelList\"`.","type":"string"},"labels":{"description":"The list of labels.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Label"}},"nextPageToken":{"description":"The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"}}},"drive_v3_LabelModification":{"description":"A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.","type":"object","properties":{"fieldModifications":{"description":"The list of modifications to this label's fields.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_LabelFieldModification"}},"kind":{"description":"This is always `\"drive#labelModification\"`.","type":"string"},"labelId":{"description":"The ID of the label to modify.","type":"string"},"removeLabel":{"description":"If true, the label will be removed from the file.","type":"boolean"}}},"drive_v3_ListAccessProposalsResponse":{"description":"The response to an access proposal list request.","type":"object","properties":{"accessProposals":{"description":"The list of access proposals. This field is only populated in Drive API v3.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AccessProposal"}},"nextPageToken":{"description":"The continuation token for the next page of results. This will be absent if the end of the results list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.","type":"string"}}},"drive_v3_ModifyLabelsRequest":{"description":"A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.","type":"object","properties":{"kind":{"description":"This is always `\"drive#modifyLabelsRequest\"`.","type":"string"},"labelModifications":{"description":"The list of modifications to apply to the labels on the file.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_LabelModification"}}}},"drive_v3_ModifyLabelsResponse":{"description":"Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request.","type":"object","properties":{"kind":{"description":"This is always `\"drive#modifyLabelsResponse\"`.","type":"string"},"modifiedLabels":{"description":"The list of labels which were added or updated by the request.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Label"}}}},"drive_v3_Operation":{"description":"This resource represents a long-running operation that is the result of a network API call.","type":"object","properties":{"done":{"description":"If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.","type":"boolean"},"error":{"$ref":"#/components/schemas/drive_v3_Status"},"metadata":{"description":"Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}},"name":{"description":"The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.","type":"string"},"response":{"description":"The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.","type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}}},"drive_v3_Permission":{"description":"A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.","type":"object","properties":{"allowFileDiscovery":{"description":"Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.","type":"boolean"},"deleted":{"description":"Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`.","type":"boolean"},"displayName":{"description":"Output only. The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as \"Dana A.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"cymbalgroup.com.\" * `anyone` - No `displayName` is present.","type":"string"},"domain":{"description":"Output only. The domain to which this permission refers.","readOnly":true,"type":"string"},"emailAddress":{"description":"Output only. The email address of the user or group to which this permission refers.","readOnly":true,"type":"string"},"expirationTime":{"description":"The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future","format":"date-time","type":"string"},"id":{"description":"Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values.","type":"string"},"inheritedPermissionsDisabled":{"description":"When `true`, only organizers, owners, and users with permissions added directly on the item can access it.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.","default":"drive#permission","type":"string"},"pendingOwner":{"description":"Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive.","type":"boolean"},"permissionDetails":{"description":"Output only. Details of whether the permissions on this item are inherited or are directly on this item.","readOnly":true,"type":"array","items":{"type":"object","properties":{"inherited":{"description":"Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.","type":"boolean"},"inheritedFrom":{"description":"Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.","readOnly":true,"type":"string"},"permissionType":{"description":"Output only. The permission type for this user. Supported values include: * `file` * `member`","type":"string"},"role":{"description":"Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"string"}}}},"photoLink":{"description":"Output only. A link to the user's profile photo, if available.","type":"string"},"role":{"description":"The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).","type":"string"},"teamDrivePermissionDetails":{"description":"Output only. Deprecated: Output only. Use `permissionDetails` instead.","readOnly":true,"type":"array","items":{"type":"object","properties":{"inherited":{"description":"Deprecated: Output only. Use `permissionDetails/inherited` instead.","type":"boolean"},"inheritedFrom":{"description":"Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.","type":"string"},"role":{"description":"Deprecated: Output only. Use `permissionDetails/role` instead.","type":"string"},"teamDrivePermissionType":{"description":"Deprecated: Output only. Use `permissionDetails/permissionType` instead.","type":"string"}}}},"type":{"description":"The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required.","type":"string"},"view":{"description":"Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views).","type":"string"}}},"drive_v3_PermissionList":{"description":"A list of permissions for a file.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#permissionList\"`.","default":"drive#permissionList","type":"string"},"nextPageToken":{"description":"The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"permissions":{"description":"The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Permission"}}}},"drive_v3_ReassignApprovalRequest":{"description":"Request for reassigning an approval. Reviewers can be added or replaced, but not removed.","type":"object","properties":{"addReviewers":{"description":"Optional. The list of reviewers to add.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_AddReviewer"}},"message":{"description":"Optional. A message to send to the new reviewers. This message is included in notifications for the action and in the approval activity log.","type":"string"},"replaceReviewers":{"description":"Optional. The list of reviewer replacements.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_ReplaceReviewer"}}}},"drive_v3_ReplaceReviewer":{"description":"Representation of a reviewer replacement.","type":"object","properties":{"addedReviewerEmail":{"description":"Required. The email of the reviewer to add.","type":"string"},"removedReviewerEmail":{"description":"Required. The email of the reviewer to remove.","type":"string"}}},"drive_v3_Reply":{"description":"A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.","type":"object","properties":{"action":{"description":"The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`","type":"string"},"assigneeEmailAddress":{"description":"Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.","readOnly":true,"type":"string"},"author":{"$ref":"#/components/schemas/drive_v3_User"},"content":{"description":"The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified.","type":"string"},"createdTime":{"description":"The time at which the reply was created (RFC 3339 date-time).","format":"date-time","type":"string"},"deleted":{"description":"Output only. Whether the reply has been deleted. A deleted reply has no content.","type":"boolean"},"htmlContent":{"description":"Output only. The content of the reply with HTML formatting.","type":"string"},"id":{"description":"Output only. The ID of the reply.","type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`.","default":"drive#reply","type":"string"},"mentionedEmailAddresses":{"description":"Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.","readOnly":true,"type":"array","items":{"type":"string"}},"modifiedTime":{"description":"The last time the reply was modified (RFC 3339 date-time).","format":"date-time","type":"string"}}},"drive_v3_ReplyList":{"description":"A list of replies to a comment on a file.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#replyList\"`.","default":"drive#replyList","type":"string"},"nextPageToken":{"description":"The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"replies":{"description":"The list of replies. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Reply"}}}},"drive_v3_ResolveAccessProposalRequest":{"description":"Request message for resolving an AccessProposal on a file.","type":"object","properties":{"action":{"description":"Required. The action to take on the access proposal.","enum":["ACTION_UNSPECIFIED","ACCEPT","DENY"],"type":"string"},"role":{"description":"Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.","type":"array","items":{"type":"string"}},"sendNotification":{"description":"Optional. Whether to send an email to the requester when the access proposal is denied or accepted.","type":"boolean"},"view":{"description":"Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.","type":"string"}}},"drive_v3_ReviewerResponse":{"description":"A response on an approval made by a specific reviewer.","type":"object","properties":{"kind":{"description":"This is always drive#reviewerResponse.","type":"string"},"response":{"description":"A reviewer’s response for the approval.","enum":["RESPONSE_UNSPECIFIED","NO_RESPONSE","APPROVED","DECLINED"],"type":"string"},"reviewer":{"$ref":"#/components/schemas/drive_v3_User"}}},"drive_v3_Revision":{"description":"The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.","type":"object","properties":{"exportLinks":{"description":"Output only. Links for exporting Docs Editors files to specific formats.","type":"object","additionalProperties":{"type":"string"}},"id":{"description":"Output only. The ID of the revision.","type":"string"},"keepForever":{"description":"Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.","type":"boolean"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#revision\"`.","default":"drive#revision","type":"string"},"lastModifyingUser":{"$ref":"#/components/schemas/drive_v3_User"},"md5Checksum":{"description":"Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.","type":"string"},"mimeType":{"description":"Output only. The MIME type of the revision.","type":"string"},"modifiedTime":{"description":"The last time the revision was modified (RFC 3339 date-time).","format":"date-time","type":"string"},"originalFilename":{"description":"Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.","type":"string"},"publishAuto":{"description":"Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.","type":"boolean"},"published":{"description":"Whether this revision is published. This is only applicable to Docs Editors files.","type":"boolean"},"publishedLink":{"description":"Output only. A link to the published revision. This is only populated for Docs Editors files.","type":"string"},"publishedOutsideDomain":{"description":"Whether this revision is published outside the domain. This is only applicable to Docs Editors files.","type":"boolean"},"size":{"description":"Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.","format":"int64","type":"string"}}},"drive_v3_RevisionList":{"description":"A list of revisions of a file.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#revisionList\"`.","default":"drive#revisionList","type":"string"},"nextPageToken":{"description":"The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"revisions":{"description":"The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_Revision"}}}},"drive_v3_StartApprovalRequest":{"description":"Allows creating an approval on a file.","type":"object","properties":{"dueTime":{"description":"Optional. The time that the approval is due.","format":"google-datetime","type":"string"},"fileContentChangeBehavior":{"description":"Optional. The behavior of the approval when the file content changes.","enum":["FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED","RESET_APPROVAL","NO_APPROVAL_ACTION"],"type":"string"},"lockFile":{"description":"Optional. Whether to lock the file when starting the approval.","type":"boolean"},"message":{"description":"Optional. A message to send to reviewers when notifying them of the approval request.","type":"string"},"reviewerEmails":{"description":"Required. The emails of the users who are set to review the approval.","type":"array","items":{"type":"string"}}}},"drive_v3_StartPageToken":{"type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#startPageToken\"`.","default":"drive#startPageToken","type":"string"},"startPageToken":{"description":"The starting page token for listing future changes. The page token doesn't expire.","type":"string"}}},"drive_v3_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"drive_v3_TeamDrive":{"description":"Deprecated: use the drive collection instead. Next ID: 33","type":"object","properties":{"backgroundImageFile":{"description":"The background image file for a Team Drive.","type":"object","properties":{"id":{"description":"The ID of an image file in Drive to use for the background image.","type":"string"},"width":{"description":"The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.","format":"float","type":"number"},"xCoordinate":{"description":"The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.","format":"float","type":"number"},"yCoordinate":{"description":"The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.","format":"float","type":"number"}}},"backgroundImageLink":{"description":"A short-lived link to this Team Drive's background image.","type":"string"},"capabilities":{"description":"Capabilities the current user has on this Team Drive.","type":"object","properties":{"canAddChildren":{"description":"Whether the current user can add children to folders in this Team Drive.","type":"boolean"},"canChangeCopyRequiresWriterPermissionRestriction":{"description":"Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.","type":"boolean"},"canChangeDomainUsersOnlyRestriction":{"description":"Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.","type":"boolean"},"canChangeDownloadRestriction":{"description":"Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.","readOnly":true,"type":"boolean"},"canChangeSharingFoldersRequiresOrganizerPermissionRestriction":{"description":"Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.","type":"boolean"},"canChangeTeamDriveBackground":{"description":"Whether the current user can change the background of this Team Drive.","type":"boolean"},"canChangeTeamMembersOnlyRestriction":{"description":"Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.","type":"boolean"},"canComment":{"description":"Whether the current user can comment on files in this Team Drive.","type":"boolean"},"canCopy":{"description":"Whether the current user can copy files in this Team Drive.","type":"boolean"},"canDeleteChildren":{"description":"Whether the current user can delete children from folders in this Team Drive.","type":"boolean"},"canDeleteTeamDrive":{"description":"Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.","type":"boolean"},"canDownload":{"description":"Whether the current user can download files in this Team Drive.","type":"boolean"},"canEdit":{"description":"Whether the current user can edit files in this Team Drive","type":"boolean"},"canListChildren":{"description":"Whether the current user can list the children of folders in this Team Drive.","type":"boolean"},"canManageMembers":{"description":"Whether the current user can add members to this Team Drive or remove them or change their role.","type":"boolean"},"canReadRevisions":{"description":"Whether the current user can read the revisions resource of files in this Team Drive.","type":"boolean"},"canRemoveChildren":{"description":"Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.","type":"boolean"},"canRename":{"description":"Whether the current user can rename files or folders in this Team Drive.","type":"boolean"},"canRenameTeamDrive":{"description":"Whether the current user can rename this Team Drive.","type":"boolean"},"canResetTeamDriveRestrictions":{"description":"Whether the current user can reset the Team Drive restrictions to defaults.","type":"boolean"},"canShare":{"description":"Whether the current user can share files or folders in this Team Drive.","type":"boolean"},"canTrashChildren":{"description":"Whether the current user can trash children from folders in this Team Drive.","type":"boolean"}}},"colorRgb":{"description":"The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.","type":"string"},"createdTime":{"description":"The time at which the Team Drive was created (RFC 3339 date-time).","format":"date-time","type":"string"},"id":{"description":"The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDrive\"`.","default":"drive#teamDrive","type":"string"},"name":{"description":"The name of this Team Drive.","type":"string"},"orgUnitId":{"description":"The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.","type":"string"},"restrictions":{"description":"A set of restrictions that apply to this Team Drive or items inside this Team Drive.","type":"object","properties":{"adminManagedRestrictions":{"description":"Whether administrative privileges on this Team Drive are required to modify restrictions.","type":"boolean"},"copyRequiresWriterPermission":{"description":"Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive.","type":"boolean"},"domainUsersOnly":{"description":"Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.","type":"boolean"},"downloadRestriction":{"$ref":"#/components/schemas/drive_v3_DownloadRestriction"},"sharingFoldersRequiresOrganizerPermission":{"description":"If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.","type":"boolean"},"teamMembersOnly":{"description":"Whether access to items inside this Team Drive is restricted to members of this Team Drive.","type":"boolean"}}},"themeId":{"description":"The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.","type":"string"}}},"drive_v3_TeamDriveList":{"description":"A list of Team Drives.","type":"object","properties":{"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDriveList\"`.","default":"drive#teamDriveList","type":"string"},"nextPageToken":{"description":"The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.","type":"string"},"teamDrives":{"description":"The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.","type":"array","items":{"$ref":"#/components/schemas/drive_v3_TeamDrive"}}}},"drive_v3_User":{"description":"Information about a Drive user.","type":"object","properties":{"displayName":{"description":"Output only. A plain text displayable name for this user.","readOnly":true,"type":"string"},"emailAddress":{"description":"Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.","readOnly":true,"type":"string"},"kind":{"description":"Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.","readOnly":true,"default":"drive#user","type":"string"},"me":{"description":"Output only. Whether this user is the requesting user.","readOnly":true,"type":"boolean"},"permissionId":{"description":"Output only. The user's ID as visible in Permission resources.","readOnly":true,"type":"string"},"photoLink":{"description":"Output only. A link to the user's profile photo, if available.","readOnly":true,"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/drive":"See, edit, create, and delete all of your Google Drive files","https://www.googleapis.com/auth/drive.appdata":"See, create, and delete its own configuration data in your Google Drive","https://www.googleapis.com/auth/drive.file":"See, edit, create, and delete only the specific Google Drive files you use with this app","https://www.googleapis.com/auth/drive.meet.readonly":"See and download your Google Drive files that were created or edited by Google Meet.","https://www.googleapis.com/auth/drive.metadata":"View and manage metadata of files in your Google Drive","https://www.googleapis.com/auth/drive.metadata.readonly":"See information about your Google Drive files","https://www.googleapis.com/auth/drive.photos.readonly":"View the photos, videos and albums in your Google Photos","https://www.googleapis.com/auth/drive.readonly":"See and download all your Google Drive files","https://www.googleapis.com/auth/drive.scripts":"Modify your Google Apps Script scripts' behavior"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/drive"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/drive/v3/rest","service":"drive","version":"v3"}]}} \ No newline at end of file diff --git a/public/specs/google/google-forms.json b/public/specs/google/google-forms.json index fed18212..d2904556 100644 --- a/public/specs/google/google-forms.json +++ b/public/specs/google/google-forms.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Forms API","version":"v1","description":"Reads and writes Google Forms and responses."},"servers":[{"url":"https://forms.googleapis.com/"}],"paths":{"/v1/forms":{"post":{"operationId":"forms.forms.create","x-executor-toolPath":"forms.forms.create","tags":["Google Forms API"],"description":"Create a new form using the title given in the provided form message in the request. *Important:* Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"unpublished","in":"query","required":false,"description":"Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses.","schema":{"description":"Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Form"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Form"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body"]}},"/v1/forms/{formId}":{"get":{"operationId":"forms.forms.get","x-executor-toolPath":"forms.forms.get","tags":["Google Forms API"],"description":"Get a form.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The form ID.","schema":{"description":"Required. The form ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Form"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body"]}},"/v1/forms/{formId}/responses":{"get":{"operationId":"forms.forms.responses.list","x-executor-toolPath":"forms.forms.responses.list","tags":["Google Forms API"],"description":"List a form's responses.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. ID of the Form whose responses to list.","schema":{"description":"Required. ID of the Form whose responses to list.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses submitted after (but not at) timestamp *N*. * timestamp >= *N* which means to get all form responses submitted at and after timestamp *N*. For both supported filters, timestamp must be formatted in RFC3339 UTC \"Zulu\" format. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".","schema":{"description":"Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses submitted after (but not at) timestamp *N*. * timestamp >= *N* which means to get all form responses submitted at and after timestamp *N*. For both supported filters, timestamp must be formatted in RFC3339 UTC \"Zulu\" format. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.","schema":{"description":"The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.","schema":{"description":"A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_ListFormResponsesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/responses/{responseId}":{"get":{"operationId":"forms.forms.responses.get","x-executor-toolPath":"forms.forms.responses.get","tags":["Google Forms API"],"description":"Get one response from the form.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The form ID.","schema":{"description":"Required. The form ID.","type":"string"}},{"name":"responseId","in":"path","required":true,"description":"Required. The response ID within the form.","schema":{"description":"Required. The response ID within the form.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_FormResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/watches":{"get":{"operationId":"forms.forms.watches.list","x-executor-toolPath":"forms.forms.watches.list","tags":["Google Forms API"],"description":"Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. ID of the Form whose watches to list.","schema":{"description":"Required. ID of the Form whose watches to list.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_ListWatchesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]},"post":{"operationId":"forms.forms.watches.create","x-executor-toolPath":"forms.forms.watches.create","tags":["Google Forms API"],"description":"Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time).","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. ID of the Form to watch.","schema":{"description":"Required. ID of the Form to watch.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_CreateWatchRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Watch"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/watches/{watchId}":{"delete":{"operationId":"forms.forms.watches.delete","x-executor-toolPath":"forms.forms.watches.delete","tags":["Google Forms API"],"description":"Delete a watch.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The ID of the Form.","schema":{"description":"Required. The ID of the Form.","type":"string"}},{"name":"watchId","in":"path","required":true,"description":"Required. The ID of the Watch to delete.","schema":{"description":"Required. The ID of the Watch to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/watches/{watchId}:renew":{"post":{"operationId":"forms.forms.watches.renew","x-executor-toolPath":"forms.forms.watches.renew","tags":["Google Forms API"],"description":"Renew an existing watch for seven days. The state of the watch after renewal is `ACTIVE`, and the `expire_time` is seven days from the renewal. Renewing a watch in an error state (e.g. `SUSPENDED`) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns `NOT_FOUND`.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The ID of the Form.","schema":{"description":"Required. The ID of the Form.","type":"string"}},{"name":"watchId","in":"path","required":true,"description":"Required. The ID of the Watch to renew.","schema":{"description":"Required. The ID of the Watch to renew.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_RenewWatchRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Watch"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}:batchUpdate":{"post":{"operationId":"forms.forms.batchUpdate","x-executor-toolPath":"forms.forms.batchUpdate","tags":["Google Forms API"],"description":"Change the form with a batch of updates.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The form ID.","schema":{"description":"Required. The form ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_BatchUpdateFormRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_BatchUpdateFormResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body"]}},"/v1/forms/{formId}:setPublishSettings":{"post":{"operationId":"forms.forms.setPublishSettings","x-executor-toolPath":"forms.forms.setPublishSettings","tags":["Google Forms API"],"description":"Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The ID of the form. You can get the id from Form.form_id field.","schema":{"description":"Required. The ID of the form. You can get the id from Form.form_id field.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_SetPublishSettingsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_SetPublishSettingsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body"]}}},"components":{"schemas":{"forms_v1_Answer":{"description":"The submitted answer for a question.","type":"object","properties":{"fileUploadAnswers":{"$ref":"#/components/schemas/forms_v1_FileUploadAnswers"},"grade":{"$ref":"#/components/schemas/forms_v1_Grade"},"questionId":{"description":"Output only. The question's ID. See also Question.question_id.","readOnly":true,"type":"string"},"textAnswers":{"$ref":"#/components/schemas/forms_v1_TextAnswers"}}},"forms_v1_BatchUpdateFormRequest":{"description":"A batch of updates to perform on a form. All the specified updates are made or none of them are.","type":"object","properties":{"includeFormInResponse":{"description":"Whether to return an updated version of the model in the response.","type":"boolean"},"requests":{"description":"Required. The update requests of this batch.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Request"}},"writeControl":{"$ref":"#/components/schemas/forms_v1_WriteControl"}}},"forms_v1_BatchUpdateFormResponse":{"description":"Response to a BatchUpdateFormRequest.","type":"object","properties":{"form":{"$ref":"#/components/schemas/forms_v1_Form"},"replies":{"description":"The reply of the updates. This maps 1:1 with the update requests, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Response"}},"writeControl":{"$ref":"#/components/schemas/forms_v1_WriteControl"}}},"forms_v1_ChoiceQuestion":{"description":"A radio/checkbox/dropdown question.","type":"object","properties":{"options":{"description":"Required. List of options that a respondent must choose from.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Option"}},"shuffle":{"description":"Whether the options should be displayed in random order for different instances of the quiz. This is often used to prevent cheating by respondents who might be looking at another respondent's screen, or to address bias in a survey that might be introduced by always putting the same options first or last.","type":"boolean"},"type":{"description":"Required. The type of choice question.","enum":["CHOICE_TYPE_UNSPECIFIED","RADIO","CHECKBOX","DROP_DOWN"],"type":"string"}}},"forms_v1_CloudPubsubTopic":{"description":"A Pub/Sub topic.","type":"object","properties":{"topicName":{"description":"Required. A fully qualified Pub/Sub topic name to publish the events to. This topic must be owned by the calling project and already exist in Pub/Sub.","type":"string"}}},"forms_v1_CorrectAnswer":{"description":"A single correct answer for a question. For multiple-valued (`CHECKBOX`) questions, several `CorrectAnswer`s may be needed to represent a single correct response option.","type":"object","properties":{"value":{"description":"Required. The correct answer value. See the documentation for TextAnswer.value for details on how various value types are formatted.","type":"string"}}},"forms_v1_CorrectAnswers":{"description":"The answer key for a question.","type":"object","properties":{"answers":{"description":"A list of correct answers. A quiz response can be automatically graded based on these answers. For single-valued questions, a response is marked correct if it matches any value in this list (in other words, multiple correct answers are possible). For multiple-valued (`CHECKBOX`) questions, a response is marked correct if it contains exactly the values in this list.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_CorrectAnswer"}}}},"forms_v1_CreateItemRequest":{"description":"Create an item in a form.","type":"object","properties":{"item":{"$ref":"#/components/schemas/forms_v1_Item"},"location":{"$ref":"#/components/schemas/forms_v1_Location"}}},"forms_v1_CreateItemResponse":{"description":"The result of creating an item.","type":"object","properties":{"itemId":{"description":"The ID of the created item.","type":"string"},"questionId":{"description":"The ID of the question created as part of this item, for a question group it lists IDs of all the questions created for this item.","type":"array","items":{"type":"string"}}}},"forms_v1_CreateWatchRequest":{"description":"Create a new watch.","type":"object","properties":{"watch":{"$ref":"#/components/schemas/forms_v1_Watch"},"watchId":{"description":"The ID to use for the watch. If specified, the ID must not already be in use. If not specified, an ID is generated. This value should be 4-63 characters, and valid characters are /a-z-/.","type":"string"}}},"forms_v1_DateQuestion":{"description":"A date question. Date questions default to just month + day.","type":"object","properties":{"includeTime":{"description":"Whether to include the time as part of the question.","type":"boolean"},"includeYear":{"description":"Whether to include the year as part of the question.","type":"boolean"}}},"forms_v1_DeleteItemRequest":{"description":"Delete an item in a form.","type":"object","properties":{"location":{"$ref":"#/components/schemas/forms_v1_Location"}}},"forms_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"forms_v1_ExtraMaterial":{"description":"Supplementary material to the feedback.","type":"object","properties":{"link":{"$ref":"#/components/schemas/forms_v1_TextLink"},"video":{"$ref":"#/components/schemas/forms_v1_VideoLink"}}},"forms_v1_Feedback":{"description":"Feedback for a respondent about their response to a question.","type":"object","properties":{"material":{"description":"Additional information provided as part of the feedback, often used to point the respondent to more reading and resources.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_ExtraMaterial"}},"text":{"description":"Required. The main text of the feedback.","type":"string"}}},"forms_v1_FileUploadAnswer":{"description":"Info for a single file submitted to a file upload question.","type":"object","properties":{"fileId":{"description":"Output only. The ID of the Google Drive file.","readOnly":true,"type":"string"},"fileName":{"description":"Output only. The file name, as stored in Google Drive on upload.","readOnly":true,"type":"string"},"mimeType":{"description":"Output only. The MIME type of the file, as stored in Google Drive on upload.","readOnly":true,"type":"string"}}},"forms_v1_FileUploadAnswers":{"description":"All submitted files for a FileUpload question.","type":"object","properties":{"answers":{"description":"Output only. All submitted files for a FileUpload question.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/forms_v1_FileUploadAnswer"}}}},"forms_v1_FileUploadQuestion":{"description":"A file upload question. The API currently does not support creating file upload questions.","type":"object","properties":{"folderId":{"description":"Required. The ID of the Drive folder where uploaded files are stored.","type":"string"},"maxFileSize":{"description":"Maximum number of bytes allowed for any single file uploaded to this question.","format":"int64","type":"string"},"maxFiles":{"description":"Maximum number of files that can be uploaded for this question in a single response.","format":"int32","type":"integer"},"types":{"description":"File types accepted by this question.","type":"array","items":{"enum":["FILE_TYPE_UNSPECIFIED","ANY","DOCUMENT","PRESENTATION","SPREADSHEET","DRAWING","PDF","IMAGE","VIDEO","AUDIO"],"type":"string"}}}},"forms_v1_Form":{"description":"A Google Forms document. A form is created in Drive, and deleting a form or changing its access protections is done via the [Drive API](https://developers.google.com/drive/api/v3/about-sdk).","type":"object","properties":{"formId":{"description":"Output only. The form ID.","readOnly":true,"type":"string"},"info":{"$ref":"#/components/schemas/forms_v1_Info"},"items":{"description":"Required. A list of the form's items, which can include section headers, questions, embedded media, etc.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Item"}},"linkedSheetId":{"description":"Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).","readOnly":true,"type":"string"},"publishSettings":{"$ref":"#/components/schemas/forms_v1_PublishSettings"},"responderUri":{"description":"Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. For forms that have publish_settings value set, this is the published form URI.","readOnly":true,"type":"string"},"revisionId":{"description":"Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published)","readOnly":true,"type":"string"},"settings":{"$ref":"#/components/schemas/forms_v1_FormSettings"}}},"forms_v1_FormResponse":{"description":"A form response.","type":"object","properties":{"answers":{"description":"Output only. The actual answers to the questions, keyed by question_id.","readOnly":true,"type":"object","additionalProperties":{"$ref":"#/components/schemas/forms_v1_Answer"}},"createTime":{"description":"Output only. Timestamp for the first time the response was submitted.","format":"google-datetime","readOnly":true,"type":"string"},"formId":{"description":"Output only. The form ID.","readOnly":true,"type":"string"},"lastSubmittedTime":{"description":"Output only. Timestamp for the most recent time the response was submitted. Does not track changes to grades.","format":"google-datetime","readOnly":true,"type":"string"},"respondentEmail":{"description":"Output only. The email address (if collected) for the respondent.","readOnly":true,"type":"string"},"responseId":{"description":"Output only. The response ID.","readOnly":true,"type":"string"},"totalScore":{"description":"Output only. The total number of points the respondent received for their submission Only set if the form was a quiz and the response was graded. This includes points automatically awarded via autograding adjusted by any manual corrections entered by the form owner.","format":"double","readOnly":true,"type":"number"}}},"forms_v1_FormSettings":{"description":"A form's settings.","type":"object","properties":{"emailCollectionType":{"description":"Optional. The setting that determines whether the form collects email addresses from respondents.","enum":["EMAIL_COLLECTION_TYPE_UNSPECIFIED","DO_NOT_COLLECT","VERIFIED","RESPONDER_INPUT"],"type":"string"},"quizSettings":{"$ref":"#/components/schemas/forms_v1_QuizSettings"}}},"forms_v1_Grade":{"description":"Grade information associated with a respondent's answer to a question.","type":"object","properties":{"correct":{"description":"Output only. Whether the question was answered correctly or not. A zero-point score is not enough to infer incorrectness, since a correctly answered question could be worth zero points.","readOnly":true,"type":"boolean"},"feedback":{"$ref":"#/components/schemas/forms_v1_Feedback"},"score":{"description":"Output only. The numeric score awarded for the answer.","format":"double","readOnly":true,"type":"number"}}},"forms_v1_Grading":{"description":"Grading for a single question","type":"object","properties":{"correctAnswers":{"$ref":"#/components/schemas/forms_v1_CorrectAnswers"},"generalFeedback":{"$ref":"#/components/schemas/forms_v1_Feedback"},"pointValue":{"description":"Required. The maximum number of points a respondent can automatically get for a correct answer. This must not be negative.","format":"int32","type":"integer"},"whenRight":{"$ref":"#/components/schemas/forms_v1_Feedback"},"whenWrong":{"$ref":"#/components/schemas/forms_v1_Feedback"}}},"forms_v1_Grid":{"description":"A grid of choices (radio or check boxes) with each row constituting a separate question. Each row has the same choices, which are shown as the columns.","type":"object","properties":{"columns":{"$ref":"#/components/schemas/forms_v1_ChoiceQuestion"},"shuffleQuestions":{"description":"If `true`, the questions are randomly ordered. In other words, the rows appear in a different order for every respondent.","type":"boolean"}}},"forms_v1_Image":{"description":"Data representing an image.","type":"object","properties":{"altText":{"description":"A description of the image that is shown on hover and read by screenreaders.","type":"string"},"contentUri":{"description":"Output only. A URI from which you can download the image; this is valid only for a limited time.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/forms_v1_MediaProperties"},"sourceUri":{"description":"Input only. The source URI is the URI used to insert the image. The source URI can be empty when fetched.","type":"string"}}},"forms_v1_ImageItem":{"description":"An item containing an image.","type":"object","properties":{"image":{"$ref":"#/components/schemas/forms_v1_Image"}}},"forms_v1_Info":{"description":"The general information for a form.","type":"object","properties":{"description":{"description":"The description of the form.","type":"string"},"documentTitle":{"description":"Output only. The title of the document which is visible in Drive. If Info.title is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.","readOnly":true,"type":"string"},"title":{"description":"Required. The title of the form which is visible to responders.","type":"string"}}},"forms_v1_Item":{"description":"A single item of the form. `kind` defines which kind of item it is.","type":"object","properties":{"description":{"description":"The description of the item.","type":"string"},"imageItem":{"$ref":"#/components/schemas/forms_v1_ImageItem"},"itemId":{"description":"The item ID. On creation, it can be provided but the ID must not be already used in the form. If not provided, a new ID is assigned.","type":"string"},"pageBreakItem":{"$ref":"#/components/schemas/forms_v1_PageBreakItem"},"questionGroupItem":{"$ref":"#/components/schemas/forms_v1_QuestionGroupItem"},"questionItem":{"$ref":"#/components/schemas/forms_v1_QuestionItem"},"textItem":{"$ref":"#/components/schemas/forms_v1_TextItem"},"title":{"description":"The title of the item.","type":"string"},"videoItem":{"$ref":"#/components/schemas/forms_v1_VideoItem"}}},"forms_v1_ListFormResponsesResponse":{"description":"Response to a ListFormResponsesRequest.","type":"object","properties":{"nextPageToken":{"description":"If set, there are more responses. To get the next page of responses, provide this as `page_token` in a future request.","type":"string"},"responses":{"description":"The returned form responses. Note: The `formId` field is not returned in the `FormResponse` object for list requests.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_FormResponse"}}}},"forms_v1_ListWatchesResponse":{"description":"The response of a ListWatchesRequest.","type":"object","properties":{"watches":{"description":"The returned watches.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Watch"}}}},"forms_v1_Location":{"description":"A specific location in a form.","type":"object","properties":{"index":{"description":"The index of an item in the form. This must be in the range [0..*N*), where *N* is the number of items in the form.","format":"int32","type":"integer"}}},"forms_v1_MediaProperties":{"description":"Properties of the media.","type":"object","properties":{"alignment":{"description":"Position of the media.","enum":["ALIGNMENT_UNSPECIFIED","LEFT","RIGHT","CENTER"],"type":"string"},"width":{"description":"The width of the media in pixels. When the media is displayed, it is scaled to the smaller of this value or the width of the displayed form. The original aspect ratio of the media is preserved. If a width is not specified when the media is added to the form, it is set to the width of the media source. Width must be between 0 and 740, inclusive. Setting width to 0 or unspecified is only permitted when updating the media source.","format":"int32","type":"integer"}}},"forms_v1_MoveItemRequest":{"description":"Move an item in a form.","type":"object","properties":{"newLocation":{"$ref":"#/components/schemas/forms_v1_Location"},"originalLocation":{"$ref":"#/components/schemas/forms_v1_Location"}}},"forms_v1_Option":{"description":"An option for a Choice question.","type":"object","properties":{"goToAction":{"description":"Section navigation type.","enum":["GO_TO_ACTION_UNSPECIFIED","NEXT_SECTION","RESTART_FORM","SUBMIT_FORM"],"type":"string"},"goToSectionId":{"description":"Item ID of section header to go to.","type":"string"},"image":{"$ref":"#/components/schemas/forms_v1_Image"},"isOther":{"description":"Whether the option is \"other\". Currently only applies to `RADIO` and `CHECKBOX` choice types, but is not allowed in a QuestionGroupItem.","type":"boolean"},"value":{"description":"Required. The choice as presented to the user.","type":"string"}}},"forms_v1_PageBreakItem":{"description":"A page break. The title and description of this item are shown at the top of the new page.","type":"object"},"forms_v1_PublishSettings":{"description":"The publishing settings of a form.","type":"object","properties":{"publishState":{"$ref":"#/components/schemas/forms_v1_PublishState"}}},"forms_v1_PublishState":{"description":"The publishing state of a form.","type":"object","properties":{"isAcceptingResponses":{"description":"Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.","type":"boolean"},"isPublished":{"description":"Required. Whether the form is published and visible to others.","type":"boolean"}}},"forms_v1_Question":{"description":"Any question. The specific type of question is known by its `kind`.","type":"object","properties":{"choiceQuestion":{"$ref":"#/components/schemas/forms_v1_ChoiceQuestion"},"dateQuestion":{"$ref":"#/components/schemas/forms_v1_DateQuestion"},"fileUploadQuestion":{"$ref":"#/components/schemas/forms_v1_FileUploadQuestion"},"grading":{"$ref":"#/components/schemas/forms_v1_Grading"},"questionId":{"description":"Read only. The question ID. On creation, it can be provided but the ID must not be already used in the form. If not provided, a new ID is assigned.","type":"string"},"ratingQuestion":{"$ref":"#/components/schemas/forms_v1_RatingQuestion"},"required":{"description":"Whether the question must be answered in order for a respondent to submit their response.","type":"boolean"},"rowQuestion":{"$ref":"#/components/schemas/forms_v1_RowQuestion"},"scaleQuestion":{"$ref":"#/components/schemas/forms_v1_ScaleQuestion"},"textQuestion":{"$ref":"#/components/schemas/forms_v1_TextQuestion"},"timeQuestion":{"$ref":"#/components/schemas/forms_v1_TimeQuestion"}}},"forms_v1_QuestionGroupItem":{"description":"Defines a question that comprises multiple questions grouped together.","type":"object","properties":{"grid":{"$ref":"#/components/schemas/forms_v1_Grid"},"image":{"$ref":"#/components/schemas/forms_v1_Image"},"questions":{"description":"Required. A list of questions that belong in this question group. A question must only belong to one group. The `kind` of the group may affect what types of questions are allowed.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Question"}}}},"forms_v1_QuestionItem":{"description":"A form item containing a single question.","type":"object","properties":{"image":{"$ref":"#/components/schemas/forms_v1_Image"},"question":{"$ref":"#/components/schemas/forms_v1_Question"}}},"forms_v1_QuizSettings":{"description":"Settings related to quiz forms and grading. These must be updated with the UpdateSettingsRequest.","type":"object","properties":{"isQuiz":{"description":"Whether this form is a quiz or not. When true, responses are graded based on question Grading. Upon setting to false, all question Grading is deleted.","type":"boolean"}}},"forms_v1_RatingQuestion":{"description":"A rating question. The user has a range of icons to choose from.","type":"object","properties":{"iconType":{"description":"Required. The icon type to use for the rating.","enum":["RATING_ICON_TYPE_UNSPECIFIED","STAR","HEART","THUMB_UP"],"type":"string"},"ratingScaleLevel":{"description":"Required. The rating scale level of the rating question.","format":"int32","type":"integer"}}},"forms_v1_RenewWatchRequest":{"description":"Renew an existing Watch for seven days.","type":"object"},"forms_v1_Request":{"description":"The kinds of update requests that can be made.","type":"object","properties":{"createItem":{"$ref":"#/components/schemas/forms_v1_CreateItemRequest"},"deleteItem":{"$ref":"#/components/schemas/forms_v1_DeleteItemRequest"},"moveItem":{"$ref":"#/components/schemas/forms_v1_MoveItemRequest"},"updateFormInfo":{"$ref":"#/components/schemas/forms_v1_UpdateFormInfoRequest"},"updateItem":{"$ref":"#/components/schemas/forms_v1_UpdateItemRequest"},"updateSettings":{"$ref":"#/components/schemas/forms_v1_UpdateSettingsRequest"}}},"forms_v1_Response":{"description":"A single response from an update.","type":"object","properties":{"createItem":{"$ref":"#/components/schemas/forms_v1_CreateItemResponse"}}},"forms_v1_RowQuestion":{"description":"Configuration for a question that is part of a question group.","type":"object","properties":{"title":{"description":"Required. The title for the single row in the QuestionGroupItem.","type":"string"}}},"forms_v1_ScaleQuestion":{"description":"A scale question. The user has a range of numeric values to choose from.","type":"object","properties":{"high":{"description":"Required. The highest possible value for the scale.","format":"int32","type":"integer"},"highLabel":{"description":"The label to display describing the highest point on the scale.","type":"string"},"low":{"description":"Required. The lowest possible value for the scale.","format":"int32","type":"integer"},"lowLabel":{"description":"The label to display describing the lowest point on the scale.","type":"string"}}},"forms_v1_SetPublishSettingsRequest":{"description":"Updates the publish settings of a Form.","type":"object","properties":{"publishSettings":{"$ref":"#/components/schemas/forms_v1_PublishSettings"},"updateMask":{"description":"Optional. The `publish_settings` fields to update. This field mask accepts the following values: * `publish_state`: Updates or replaces all `publish_state` settings. * `\"*\"`: Updates or replaces all `publish_settings` fields.","format":"google-fieldmask","type":"string"}}},"forms_v1_SetPublishSettingsResponse":{"description":"The response of a SetPublishSettings request.","type":"object","properties":{"formId":{"description":"Required. The ID of the Form. This is same as the Form.form_id field.","type":"string"},"publishSettings":{"$ref":"#/components/schemas/forms_v1_PublishSettings"}}},"forms_v1_TextAnswer":{"description":"An answer to a question represented as text.","type":"object","properties":{"value":{"description":"Output only. The answer value. Formatting used for different kinds of question: * ChoiceQuestion * `RADIO` or `DROP_DOWN`: A single string corresponding to the option that was selected. * `CHECKBOX`: Multiple strings corresponding to each option that was selected. * TextQuestion: The text that the user entered. * ScaleQuestion: A string containing the number that was selected. * DateQuestion * Without time or year: MM-DD e.g. \"05-19\" * With year: YYYY-MM-DD e.g. \"1986-05-19\" * With time: MM-DD HH:MM e.g. \"05-19 14:51\" * With year and time: YYYY-MM-DD HH:MM e.g. \"1986-05-19 14:51\" * TimeQuestion: String with time or duration in HH:MM format e.g. \"14:51\" * RowQuestion within QuestionGroupItem: The answer for each row of a QuestionGroupItem is represented as a separate Answer. Each will contain one string for `RADIO`-type choices or multiple strings for `CHECKBOX` choices.","readOnly":true,"type":"string"}}},"forms_v1_TextAnswers":{"description":"A question's answers as text.","type":"object","properties":{"answers":{"description":"Output only. Answers to a question. For multiple-value ChoiceQuestions, each answer is a separate value.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/forms_v1_TextAnswer"}}}},"forms_v1_TextItem":{"description":"A text item.","type":"object"},"forms_v1_TextLink":{"description":"Link for text.","type":"object","properties":{"displayText":{"description":"Required. Display text for the URI.","type":"string"},"uri":{"description":"Required. The URI.","type":"string"}}},"forms_v1_TextQuestion":{"description":"A text-based question.","type":"object","properties":{"paragraph":{"description":"Whether the question is a paragraph question or not. If not, the question is a short text question.","type":"boolean"}}},"forms_v1_TimeQuestion":{"description":"A time question.","type":"object","properties":{"duration":{"description":"`true` if the question is about an elapsed time. Otherwise it is about a time of day.","type":"boolean"}}},"forms_v1_UpdateFormInfoRequest":{"description":"Update Form's Info.","type":"object","properties":{"info":{"$ref":"#/components/schemas/forms_v1_Info"},"updateMask":{"description":"Required. Only values named in this mask are changed. At least one field must be specified. The root `info` is implied and should not be specified. A single `\"*\"` can be used as short-hand for updating every field.","format":"google-fieldmask","type":"string"}}},"forms_v1_UpdateItemRequest":{"description":"Update an item in a form.","type":"object","properties":{"item":{"$ref":"#/components/schemas/forms_v1_Item"},"location":{"$ref":"#/components/schemas/forms_v1_Location"},"updateMask":{"description":"Required. Only values named in this mask are changed.","format":"google-fieldmask","type":"string"}}},"forms_v1_UpdateSettingsRequest":{"description":"Update Form's FormSettings.","type":"object","properties":{"settings":{"$ref":"#/components/schemas/forms_v1_FormSettings"},"updateMask":{"description":"Required. Only values named in this mask are changed. At least one field must be specified. The root `settings` is implied and should not be specified. A single `\"*\"` can be used as short-hand for updating every field.","format":"google-fieldmask","type":"string"}}},"forms_v1_Video":{"description":"Data representing a video.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/forms_v1_MediaProperties"},"youtubeUri":{"description":"Required. A YouTube URI.","type":"string"}}},"forms_v1_VideoItem":{"description":"An item containing a video.","type":"object","properties":{"caption":{"description":"The text displayed below the video.","type":"string"},"video":{"$ref":"#/components/schemas/forms_v1_Video"}}},"forms_v1_VideoLink":{"description":"Link to a video.","type":"object","properties":{"displayText":{"description":"Required. The display text for the link.","type":"string"},"youtubeUri":{"description":"The URI of a YouTube video.","type":"string"}}},"forms_v1_Watch":{"description":"A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a `formId` key that has the ID of the watched form and an `eventType` key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew","type":"object","properties":{"createTime":{"description":"Output only. Timestamp of when this was created.","format":"google-datetime","readOnly":true,"type":"string"},"errorType":{"description":"Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information.","readOnly":true,"enum":["ERROR_TYPE_UNSPECIFIED","PROJECT_NOT_AUTHORIZED","NO_USER_ACCESS","OTHER_ERRORS"],"type":"string"},"eventType":{"description":"Required. Which event type to watch for.","enum":["EVENT_TYPE_UNSPECIFIED","SCHEMA","RESPONSES"],"type":"string"},"expireTime":{"description":"Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.","format":"google-datetime","readOnly":true,"type":"string"},"id":{"description":"Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.","readOnly":true,"type":"string"},"state":{"description":"Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","SUSPENDED"],"type":"string"},"target":{"$ref":"#/components/schemas/forms_v1_WatchTarget"}}},"forms_v1_WatchTarget":{"description":"The target for notification delivery.","type":"object","properties":{"topic":{"$ref":"#/components/schemas/forms_v1_CloudPubsubTopic"}}},"forms_v1_WriteControl":{"description":"Provides control over how write requests are executed.","type":"object","properties":{"requiredRevisionId":{"description":"The revision ID of the form that the write request is applied to. If this is not the latest revision of the form, the request is not processed and returns a 400 bad request error.","type":"string"},"targetRevisionId":{"description":"The target revision ID of the form that the write request is applied to. If changes have occurred after this revision, the changes in this update request are transformed against those changes. This results in a new revision of the form that incorporates both the changes in the request and the intervening changes, with the server resolving conflicting changes. The target revision ID may only be used to write to recent versions of a form. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 (Bad Request Error). The request may be retried after reading the latest version of the form. In most cases a target revision ID remains valid for several minutes after it is read, but for frequently-edited forms this window may be shorter.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/forms.body":"","https://www.googleapis.com/auth/forms.responses.readonly":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://forms.googleapis.com/$discovery/rest?version=v1","service":"forms","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Forms API","version":"v1","description":"Reads and writes Google Forms and responses."},"servers":[{"url":"https://forms.googleapis.com/"}],"paths":{"/v1/forms":{"post":{"operationId":"forms.forms.create","x-executor-toolPath":"forms.forms.create","tags":["Google Forms API"],"description":"Create a new form using the title given in the provided form message in the request. *Important:* Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"unpublished","in":"query","required":false,"description":"Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses.","schema":{"description":"Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is published and accepts responses.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Form"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Form"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body"]}},"/v1/forms/{formId}":{"get":{"operationId":"forms.forms.get","x-executor-toolPath":"forms.forms.get","tags":["Google Forms API"],"description":"Get a form.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The form ID.","schema":{"description":"Required. The form ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Form"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body.readonly","https://www.googleapis.com/auth/forms.body"]}},"/v1/forms/{formId}/responses":{"get":{"operationId":"forms.forms.responses.list","x-executor-toolPath":"forms.forms.responses.list","tags":["Google Forms API"],"description":"List a form's responses.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. ID of the Form whose responses to list.","schema":{"description":"Required. ID of the Form whose responses to list.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses submitted after (but not at) timestamp *N*. * timestamp >= *N* which means to get all form responses submitted at and after timestamp *N*. For both supported filters, timestamp must be formatted in RFC3339 UTC \"Zulu\" format. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".","schema":{"description":"Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses submitted after (but not at) timestamp *N*. * timestamp >= *N* which means to get all form responses submitted at and after timestamp *N*. For both supported filters, timestamp must be formatted in RFC3339 UTC \"Zulu\" format. Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\".","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.","schema":{"description":"The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.","schema":{"description":"A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_ListFormResponsesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/responses/{responseId}":{"get":{"operationId":"forms.forms.responses.get","x-executor-toolPath":"forms.forms.responses.get","tags":["Google Forms API"],"description":"Get one response from the form.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The form ID.","schema":{"description":"Required. The form ID.","type":"string"}},{"name":"responseId","in":"path","required":true,"description":"Required. The response ID within the form.","schema":{"description":"Required. The response ID within the form.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_FormResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/watches":{"get":{"operationId":"forms.forms.watches.list","x-executor-toolPath":"forms.forms.watches.list","tags":["Google Forms API"],"description":"Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. ID of the Form whose watches to list.","schema":{"description":"Required. ID of the Form whose watches to list.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_ListWatchesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body.readonly","https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]},"post":{"operationId":"forms.forms.watches.create","x-executor-toolPath":"forms.forms.watches.create","tags":["Google Forms API"],"description":"Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time).","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. ID of the Form to watch.","schema":{"description":"Required. ID of the Form to watch.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_CreateWatchRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Watch"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body.readonly","https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/watches/{watchId}":{"delete":{"operationId":"forms.forms.watches.delete","x-executor-toolPath":"forms.forms.watches.delete","tags":["Google Forms API"],"description":"Delete a watch.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The ID of the Form.","schema":{"description":"Required. The ID of the Form.","type":"string"}},{"name":"watchId","in":"path","required":true,"description":"Required. The ID of the Watch to delete.","schema":{"description":"Required. The ID of the Watch to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body.readonly","https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}/watches/{watchId}:renew":{"post":{"operationId":"forms.forms.watches.renew","x-executor-toolPath":"forms.forms.watches.renew","tags":["Google Forms API"],"description":"Renew an existing watch for seven days. The state of the watch after renewal is `ACTIVE`, and the `expire_time` is seven days from the renewal. Renewing a watch in an error state (e.g. `SUSPENDED`) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns `NOT_FOUND`.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The ID of the Form.","schema":{"description":"Required. The ID of the Form.","type":"string"}},{"name":"watchId","in":"path","required":true,"description":"Required. The ID of the Watch to renew.","schema":{"description":"Required. The ID of the Watch to renew.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_RenewWatchRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_Watch"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]},{"googleOAuth2":["https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body.readonly","https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}},"/v1/forms/{formId}:batchUpdate":{"post":{"operationId":"forms.forms.batchUpdate","x-executor-toolPath":"forms.forms.batchUpdate","tags":["Google Forms API"],"description":"Change the form with a batch of updates.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The form ID.","schema":{"description":"Required. The form ID.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_BatchUpdateFormRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_BatchUpdateFormResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body"]}},"/v1/forms/{formId}:setPublishSettings":{"post":{"operationId":"forms.forms.setPublishSettings","x-executor-toolPath":"forms.forms.setPublishSettings","tags":["Google Forms API"],"description":"Updates the publish settings of a form. Legacy forms aren't supported because they don't have the `publish_settings` field.","parameters":[{"name":"formId","in":"path","required":true,"description":"Required. The ID of the form. You can get the id from Form.form_id field.","schema":{"description":"Required. The ID of the form. You can get the id from Form.form_id field.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_SetPublishSettingsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_v1_SetPublishSettingsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/forms.body"]}],"x-google-scopes":["https://www.googleapis.com/auth/forms.body"]}}},"components":{"schemas":{"forms_v1_Answer":{"description":"The submitted answer for a question.","type":"object","properties":{"fileUploadAnswers":{"$ref":"#/components/schemas/forms_v1_FileUploadAnswers"},"grade":{"$ref":"#/components/schemas/forms_v1_Grade"},"questionId":{"description":"Output only. The question's ID. See also Question.question_id.","readOnly":true,"type":"string"},"textAnswers":{"$ref":"#/components/schemas/forms_v1_TextAnswers"}}},"forms_v1_BatchUpdateFormRequest":{"description":"A batch of updates to perform on a form. All the specified updates are made or none of them are.","type":"object","properties":{"includeFormInResponse":{"description":"Whether to return an updated version of the model in the response.","type":"boolean"},"requests":{"description":"Required. The update requests of this batch.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Request"}},"writeControl":{"$ref":"#/components/schemas/forms_v1_WriteControl"}}},"forms_v1_BatchUpdateFormResponse":{"description":"Response to a BatchUpdateFormRequest.","type":"object","properties":{"form":{"$ref":"#/components/schemas/forms_v1_Form"},"replies":{"description":"The reply of the updates. This maps 1:1 with the update requests, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Response"}},"writeControl":{"$ref":"#/components/schemas/forms_v1_WriteControl"}}},"forms_v1_ChoiceQuestion":{"description":"A radio/checkbox/dropdown question.","type":"object","properties":{"options":{"description":"Required. List of options that a respondent must choose from.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Option"}},"shuffle":{"description":"Whether the options should be displayed in random order for different instances of the quiz. This is often used to prevent cheating by respondents who might be looking at another respondent's screen, or to address bias in a survey that might be introduced by always putting the same options first or last.","type":"boolean"},"type":{"description":"Required. The type of choice question.","enum":["CHOICE_TYPE_UNSPECIFIED","RADIO","CHECKBOX","DROP_DOWN"],"type":"string"}}},"forms_v1_CloudPubsubTopic":{"description":"A Pub/Sub topic.","type":"object","properties":{"topicName":{"description":"Required. A fully qualified Pub/Sub topic name to publish the events to. This topic must be owned by the calling project and already exist in Pub/Sub.","type":"string"}}},"forms_v1_CorrectAnswer":{"description":"A single correct answer for a question. For multiple-valued (`CHECKBOX`) questions, several `CorrectAnswer`s may be needed to represent a single correct response option.","type":"object","properties":{"value":{"description":"Required. The correct answer value. See the documentation for TextAnswer.value for details on how various value types are formatted.","type":"string"}}},"forms_v1_CorrectAnswers":{"description":"The answer key for a question.","type":"object","properties":{"answers":{"description":"A list of correct answers. A quiz response can be automatically graded based on these answers. For single-valued questions, a response is marked correct if it matches any value in this list (in other words, multiple correct answers are possible). For multiple-valued (`CHECKBOX`) questions, a response is marked correct if it contains exactly the values in this list.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_CorrectAnswer"}}}},"forms_v1_CreateItemRequest":{"description":"Create an item in a form.","type":"object","properties":{"item":{"$ref":"#/components/schemas/forms_v1_Item"},"location":{"$ref":"#/components/schemas/forms_v1_Location"}}},"forms_v1_CreateItemResponse":{"description":"The result of creating an item.","type":"object","properties":{"itemId":{"description":"The ID of the created item.","type":"string"},"questionId":{"description":"The ID of the question created as part of this item, for a question group it lists IDs of all the questions created for this item.","type":"array","items":{"type":"string"}}}},"forms_v1_CreateWatchRequest":{"description":"Create a new watch.","type":"object","properties":{"watch":{"$ref":"#/components/schemas/forms_v1_Watch"},"watchId":{"description":"The ID to use for the watch. If specified, the ID must not already be in use. If not specified, an ID is generated. This value should be 4-63 characters, and valid characters are /a-z-/.","type":"string"}}},"forms_v1_DateQuestion":{"description":"A date question. Date questions default to just month + day.","type":"object","properties":{"includeTime":{"description":"Whether to include the time as part of the question.","type":"boolean"},"includeYear":{"description":"Whether to include the year as part of the question.","type":"boolean"}}},"forms_v1_DeleteItemRequest":{"description":"Delete an item in a form.","type":"object","properties":{"location":{"$ref":"#/components/schemas/forms_v1_Location"}}},"forms_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"forms_v1_ExtraMaterial":{"description":"Supplementary material to the feedback.","type":"object","properties":{"link":{"$ref":"#/components/schemas/forms_v1_TextLink"},"video":{"$ref":"#/components/schemas/forms_v1_VideoLink"}}},"forms_v1_Feedback":{"description":"Feedback for a respondent about their response to a question.","type":"object","properties":{"material":{"description":"Additional information provided as part of the feedback, often used to point the respondent to more reading and resources.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_ExtraMaterial"}},"text":{"description":"Required. The main text of the feedback.","type":"string"}}},"forms_v1_FileUploadAnswer":{"description":"Info for a single file submitted to a file upload question.","type":"object","properties":{"fileId":{"description":"Output only. The ID of the Google Drive file.","readOnly":true,"type":"string"},"fileName":{"description":"Output only. The file name, as stored in Google Drive on upload.","readOnly":true,"type":"string"},"mimeType":{"description":"Output only. The MIME type of the file, as stored in Google Drive on upload.","readOnly":true,"type":"string"}}},"forms_v1_FileUploadAnswers":{"description":"All submitted files for a FileUpload question.","type":"object","properties":{"answers":{"description":"Output only. All submitted files for a FileUpload question.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/forms_v1_FileUploadAnswer"}}}},"forms_v1_FileUploadQuestion":{"description":"A file upload question. The API currently does not support creating file upload questions.","type":"object","properties":{"folderId":{"description":"Required. The ID of the Drive folder where uploaded files are stored.","type":"string"},"maxFileSize":{"description":"Maximum number of bytes allowed for any single file uploaded to this question.","format":"int64","type":"string"},"maxFiles":{"description":"Maximum number of files that can be uploaded for this question in a single response.","format":"int32","type":"integer"},"types":{"description":"File types accepted by this question.","type":"array","items":{"enum":["FILE_TYPE_UNSPECIFIED","ANY","DOCUMENT","PRESENTATION","SPREADSHEET","DRAWING","PDF","IMAGE","VIDEO","AUDIO"],"type":"string"}}}},"forms_v1_Form":{"description":"A Google Forms document. A form is created in Drive, and deleting a form or changing its access protections is done via the [Drive API](https://developers.google.com/drive/api/v3/about-sdk).","type":"object","properties":{"formId":{"description":"Output only. The form ID.","readOnly":true,"type":"string"},"info":{"$ref":"#/components/schemas/forms_v1_Info"},"items":{"description":"Required. A list of the form's items, which can include section headers, questions, embedded media, etc.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Item"}},"linkedSheetId":{"description":"Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).","readOnly":true,"type":"string"},"publishSettings":{"$ref":"#/components/schemas/forms_v1_PublishSettings"},"responderUri":{"description":"Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. For forms that have publish_settings value set, this is the published form URI.","readOnly":true,"type":"string"},"revisionId":{"description":"Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published)","readOnly":true,"type":"string"},"settings":{"$ref":"#/components/schemas/forms_v1_FormSettings"}}},"forms_v1_FormResponse":{"description":"A form response.","type":"object","properties":{"answers":{"description":"Output only. The actual answers to the questions, keyed by question_id.","readOnly":true,"type":"object","additionalProperties":{"$ref":"#/components/schemas/forms_v1_Answer"}},"createTime":{"description":"Output only. Timestamp for the first time the response was submitted.","format":"google-datetime","readOnly":true,"type":"string"},"formId":{"description":"Output only. The form ID.","readOnly":true,"type":"string"},"lastSubmittedTime":{"description":"Output only. Timestamp for the most recent time the response was submitted. Does not track changes to grades.","format":"google-datetime","readOnly":true,"type":"string"},"respondentEmail":{"description":"Output only. The email address (if collected) for the respondent.","readOnly":true,"type":"string"},"responseId":{"description":"Output only. The response ID.","readOnly":true,"type":"string"},"totalScore":{"description":"Output only. The total number of points the respondent received for their submission Only set if the form was a quiz and the response was graded. This includes points automatically awarded via autograding adjusted by any manual corrections entered by the form owner.","format":"double","readOnly":true,"type":"number"}}},"forms_v1_FormSettings":{"description":"A form's settings.","type":"object","properties":{"emailCollectionType":{"description":"Optional. The setting that determines whether the form collects email addresses from respondents.","enum":["EMAIL_COLLECTION_TYPE_UNSPECIFIED","DO_NOT_COLLECT","VERIFIED","RESPONDER_INPUT"],"type":"string"},"quizSettings":{"$ref":"#/components/schemas/forms_v1_QuizSettings"}}},"forms_v1_Grade":{"description":"Grade information associated with a respondent's answer to a question.","type":"object","properties":{"correct":{"description":"Output only. Whether the question was answered correctly or not. A zero-point score is not enough to infer incorrectness, since a correctly answered question could be worth zero points.","readOnly":true,"type":"boolean"},"feedback":{"$ref":"#/components/schemas/forms_v1_Feedback"},"score":{"description":"Output only. The numeric score awarded for the answer.","format":"double","readOnly":true,"type":"number"}}},"forms_v1_Grading":{"description":"Grading for a single question","type":"object","properties":{"correctAnswers":{"$ref":"#/components/schemas/forms_v1_CorrectAnswers"},"generalFeedback":{"$ref":"#/components/schemas/forms_v1_Feedback"},"pointValue":{"description":"Required. The maximum number of points a respondent can automatically get for a correct answer. This must not be negative.","format":"int32","type":"integer"},"whenRight":{"$ref":"#/components/schemas/forms_v1_Feedback"},"whenWrong":{"$ref":"#/components/schemas/forms_v1_Feedback"}}},"forms_v1_Grid":{"description":"A grid of choices (radio or check boxes) with each row constituting a separate question. Each row has the same choices, which are shown as the columns.","type":"object","properties":{"columns":{"$ref":"#/components/schemas/forms_v1_ChoiceQuestion"},"shuffleQuestions":{"description":"If `true`, the questions are randomly ordered. In other words, the rows appear in a different order for every respondent.","type":"boolean"}}},"forms_v1_Image":{"description":"Data representing an image.","type":"object","properties":{"altText":{"description":"A description of the image that is shown on hover and read by screenreaders.","type":"string"},"contentUri":{"description":"Output only. A URI from which you can download the image; this is valid only for a limited time.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/forms_v1_MediaProperties"},"sourceUri":{"description":"Input only. The source URI is the URI used to insert the image. The source URI can be empty when fetched.","type":"string"}}},"forms_v1_ImageItem":{"description":"An item containing an image.","type":"object","properties":{"image":{"$ref":"#/components/schemas/forms_v1_Image"}}},"forms_v1_Info":{"description":"The general information for a form.","type":"object","properties":{"description":{"description":"The description of the form.","type":"string"},"documentTitle":{"description":"Output only. The title of the document which is visible in Drive. If Info.title is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.","readOnly":true,"type":"string"},"title":{"description":"Required. The title of the form which is visible to responders.","type":"string"}}},"forms_v1_Item":{"description":"A single item of the form. `kind` defines which kind of item it is.","type":"object","properties":{"description":{"description":"The description of the item.","type":"string"},"imageItem":{"$ref":"#/components/schemas/forms_v1_ImageItem"},"itemId":{"description":"The item ID. On creation, it can be provided but the ID must not be already used in the form. If not provided, a new ID is assigned.","type":"string"},"pageBreakItem":{"$ref":"#/components/schemas/forms_v1_PageBreakItem"},"questionGroupItem":{"$ref":"#/components/schemas/forms_v1_QuestionGroupItem"},"questionItem":{"$ref":"#/components/schemas/forms_v1_QuestionItem"},"textItem":{"$ref":"#/components/schemas/forms_v1_TextItem"},"title":{"description":"The title of the item.","type":"string"},"videoItem":{"$ref":"#/components/schemas/forms_v1_VideoItem"}}},"forms_v1_ListFormResponsesResponse":{"description":"Response to a ListFormResponsesRequest.","type":"object","properties":{"nextPageToken":{"description":"If set, there are more responses. To get the next page of responses, provide this as `page_token` in a future request.","type":"string"},"responses":{"description":"The returned form responses. Note: The `formId` field is not returned in the `FormResponse` object for list requests.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_FormResponse"}}}},"forms_v1_ListWatchesResponse":{"description":"The response of a ListWatchesRequest.","type":"object","properties":{"watches":{"description":"The returned watches.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Watch"}}}},"forms_v1_Location":{"description":"A specific location in a form.","type":"object","properties":{"index":{"description":"The index of an item in the form. This must be in the range [0..*N*), where *N* is the number of items in the form.","format":"int32","type":"integer"}}},"forms_v1_MediaProperties":{"description":"Properties of the media.","type":"object","properties":{"alignment":{"description":"Position of the media.","enum":["ALIGNMENT_UNSPECIFIED","LEFT","RIGHT","CENTER"],"type":"string"},"width":{"description":"The width of the media in pixels. When the media is displayed, it is scaled to the smaller of this value or the width of the displayed form. The original aspect ratio of the media is preserved. If a width is not specified when the media is added to the form, it is set to the width of the media source. Width must be between 0 and 740, inclusive. Setting width to 0 or unspecified is only permitted when updating the media source.","format":"int32","type":"integer"}}},"forms_v1_MoveItemRequest":{"description":"Move an item in a form.","type":"object","properties":{"newLocation":{"$ref":"#/components/schemas/forms_v1_Location"},"originalLocation":{"$ref":"#/components/schemas/forms_v1_Location"}}},"forms_v1_Option":{"description":"An option for a Choice question.","type":"object","properties":{"goToAction":{"description":"Section navigation type.","enum":["GO_TO_ACTION_UNSPECIFIED","NEXT_SECTION","RESTART_FORM","SUBMIT_FORM"],"type":"string"},"goToSectionId":{"description":"Item ID of section header to go to.","type":"string"},"image":{"$ref":"#/components/schemas/forms_v1_Image"},"isOther":{"description":"Whether the option is \"other\". Currently only applies to `RADIO` and `CHECKBOX` choice types, but is not allowed in a QuestionGroupItem.","type":"boolean"},"value":{"description":"Required. The choice as presented to the user.","type":"string"}}},"forms_v1_PageBreakItem":{"description":"A page break. The title and description of this item are shown at the top of the new page.","type":"object"},"forms_v1_PublishSettings":{"description":"The publishing settings of a form.","type":"object","properties":{"publishState":{"$ref":"#/components/schemas/forms_v1_PublishState"}}},"forms_v1_PublishState":{"description":"The publishing state of a form.","type":"object","properties":{"isAcceptingResponses":{"description":"Required. Whether the form accepts responses. If `is_published` is set to `false`, this field is forced to `false`.","type":"boolean"},"isPublished":{"description":"Required. Whether the form is published and visible to others.","type":"boolean"}}},"forms_v1_Question":{"description":"Any question. The specific type of question is known by its `kind`.","type":"object","properties":{"choiceQuestion":{"$ref":"#/components/schemas/forms_v1_ChoiceQuestion"},"dateQuestion":{"$ref":"#/components/schemas/forms_v1_DateQuestion"},"fileUploadQuestion":{"$ref":"#/components/schemas/forms_v1_FileUploadQuestion"},"grading":{"$ref":"#/components/schemas/forms_v1_Grading"},"questionId":{"description":"Read only. The question ID. On creation, it can be provided but the ID must not be already used in the form. If not provided, a new ID is assigned.","type":"string"},"ratingQuestion":{"$ref":"#/components/schemas/forms_v1_RatingQuestion"},"required":{"description":"Whether the question must be answered in order for a respondent to submit their response.","type":"boolean"},"rowQuestion":{"$ref":"#/components/schemas/forms_v1_RowQuestion"},"scaleQuestion":{"$ref":"#/components/schemas/forms_v1_ScaleQuestion"},"textQuestion":{"$ref":"#/components/schemas/forms_v1_TextQuestion"},"timeQuestion":{"$ref":"#/components/schemas/forms_v1_TimeQuestion"}}},"forms_v1_QuestionGroupItem":{"description":"Defines a question that comprises multiple questions grouped together.","type":"object","properties":{"grid":{"$ref":"#/components/schemas/forms_v1_Grid"},"image":{"$ref":"#/components/schemas/forms_v1_Image"},"questions":{"description":"Required. A list of questions that belong in this question group. A question must only belong to one group. The `kind` of the group may affect what types of questions are allowed.","type":"array","items":{"$ref":"#/components/schemas/forms_v1_Question"}}}},"forms_v1_QuestionItem":{"description":"A form item containing a single question.","type":"object","properties":{"image":{"$ref":"#/components/schemas/forms_v1_Image"},"question":{"$ref":"#/components/schemas/forms_v1_Question"}}},"forms_v1_QuizSettings":{"description":"Settings related to quiz forms and grading. These must be updated with the UpdateSettingsRequest.","type":"object","properties":{"isQuiz":{"description":"Whether this form is a quiz or not. When true, responses are graded based on question Grading. Upon setting to false, all question Grading is deleted.","type":"boolean"}}},"forms_v1_RatingQuestion":{"description":"A rating question. The user has a range of icons to choose from.","type":"object","properties":{"iconType":{"description":"Required. The icon type to use for the rating.","enum":["RATING_ICON_TYPE_UNSPECIFIED","STAR","HEART","THUMB_UP"],"type":"string"},"ratingScaleLevel":{"description":"Required. The rating scale level of the rating question.","format":"int32","type":"integer"}}},"forms_v1_RenewWatchRequest":{"description":"Renew an existing Watch for seven days.","type":"object"},"forms_v1_Request":{"description":"The kinds of update requests that can be made.","type":"object","properties":{"createItem":{"$ref":"#/components/schemas/forms_v1_CreateItemRequest"},"deleteItem":{"$ref":"#/components/schemas/forms_v1_DeleteItemRequest"},"moveItem":{"$ref":"#/components/schemas/forms_v1_MoveItemRequest"},"updateFormInfo":{"$ref":"#/components/schemas/forms_v1_UpdateFormInfoRequest"},"updateItem":{"$ref":"#/components/schemas/forms_v1_UpdateItemRequest"},"updateSettings":{"$ref":"#/components/schemas/forms_v1_UpdateSettingsRequest"}}},"forms_v1_Response":{"description":"A single response from an update.","type":"object","properties":{"createItem":{"$ref":"#/components/schemas/forms_v1_CreateItemResponse"}}},"forms_v1_RowQuestion":{"description":"Configuration for a question that is part of a question group.","type":"object","properties":{"title":{"description":"Required. The title for the single row in the QuestionGroupItem.","type":"string"}}},"forms_v1_ScaleQuestion":{"description":"A scale question. The user has a range of numeric values to choose from.","type":"object","properties":{"high":{"description":"Required. The highest possible value for the scale.","format":"int32","type":"integer"},"highLabel":{"description":"The label to display describing the highest point on the scale.","type":"string"},"low":{"description":"Required. The lowest possible value for the scale.","format":"int32","type":"integer"},"lowLabel":{"description":"The label to display describing the lowest point on the scale.","type":"string"}}},"forms_v1_SetPublishSettingsRequest":{"description":"Updates the publish settings of a Form.","type":"object","properties":{"publishSettings":{"$ref":"#/components/schemas/forms_v1_PublishSettings"},"updateMask":{"description":"Optional. The `publish_settings` fields to update. This field mask accepts the following values: * `publish_state`: Updates or replaces all `publish_state` settings. * `\"*\"`: Updates or replaces all `publish_settings` fields.","format":"google-fieldmask","type":"string"}}},"forms_v1_SetPublishSettingsResponse":{"description":"The response of a SetPublishSettings request.","type":"object","properties":{"formId":{"description":"Required. The ID of the Form. This is same as the Form.form_id field.","type":"string"},"publishSettings":{"$ref":"#/components/schemas/forms_v1_PublishSettings"}}},"forms_v1_TextAnswer":{"description":"An answer to a question represented as text.","type":"object","properties":{"value":{"description":"Output only. The answer value. Formatting used for different kinds of question: * ChoiceQuestion * `RADIO` or `DROP_DOWN`: A single string corresponding to the option that was selected. * `CHECKBOX`: Multiple strings corresponding to each option that was selected. * TextQuestion: The text that the user entered. * ScaleQuestion: A string containing the number that was selected. * DateQuestion * Without time or year: MM-DD e.g. \"05-19\" * With year: YYYY-MM-DD e.g. \"1986-05-19\" * With time: MM-DD HH:MM e.g. \"05-19 14:51\" * With year and time: YYYY-MM-DD HH:MM e.g. \"1986-05-19 14:51\" * TimeQuestion: String with time or duration in HH:MM format e.g. \"14:51\" * RowQuestion within QuestionGroupItem: The answer for each row of a QuestionGroupItem is represented as a separate Answer. Each will contain one string for `RADIO`-type choices or multiple strings for `CHECKBOX` choices.","readOnly":true,"type":"string"}}},"forms_v1_TextAnswers":{"description":"A question's answers as text.","type":"object","properties":{"answers":{"description":"Output only. Answers to a question. For multiple-value ChoiceQuestions, each answer is a separate value.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/forms_v1_TextAnswer"}}}},"forms_v1_TextItem":{"description":"A text item.","type":"object"},"forms_v1_TextLink":{"description":"Link for text.","type":"object","properties":{"displayText":{"description":"Required. Display text for the URI.","type":"string"},"uri":{"description":"Required. The URI.","type":"string"}}},"forms_v1_TextQuestion":{"description":"A text-based question.","type":"object","properties":{"paragraph":{"description":"Whether the question is a paragraph question or not. If not, the question is a short text question.","type":"boolean"}}},"forms_v1_TimeQuestion":{"description":"A time question.","type":"object","properties":{"duration":{"description":"`true` if the question is about an elapsed time. Otherwise it is about a time of day.","type":"boolean"}}},"forms_v1_UpdateFormInfoRequest":{"description":"Update Form's Info.","type":"object","properties":{"info":{"$ref":"#/components/schemas/forms_v1_Info"},"updateMask":{"description":"Required. Only values named in this mask are changed. At least one field must be specified. The root `info` is implied and should not be specified. A single `\"*\"` can be used as short-hand for updating every field.","format":"google-fieldmask","type":"string"}}},"forms_v1_UpdateItemRequest":{"description":"Update an item in a form.","type":"object","properties":{"item":{"$ref":"#/components/schemas/forms_v1_Item"},"location":{"$ref":"#/components/schemas/forms_v1_Location"},"updateMask":{"description":"Required. Only values named in this mask are changed.","format":"google-fieldmask","type":"string"}}},"forms_v1_UpdateSettingsRequest":{"description":"Update Form's FormSettings.","type":"object","properties":{"settings":{"$ref":"#/components/schemas/forms_v1_FormSettings"},"updateMask":{"description":"Required. Only values named in this mask are changed. At least one field must be specified. The root `settings` is implied and should not be specified. A single `\"*\"` can be used as short-hand for updating every field.","format":"google-fieldmask","type":"string"}}},"forms_v1_Video":{"description":"Data representing a video.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/forms_v1_MediaProperties"},"youtubeUri":{"description":"Required. A YouTube URI.","type":"string"}}},"forms_v1_VideoItem":{"description":"An item containing a video.","type":"object","properties":{"caption":{"description":"The text displayed below the video.","type":"string"},"video":{"$ref":"#/components/schemas/forms_v1_Video"}}},"forms_v1_VideoLink":{"description":"Link to a video.","type":"object","properties":{"displayText":{"description":"Required. The display text for the link.","type":"string"},"youtubeUri":{"description":"The URI of a YouTube video.","type":"string"}}},"forms_v1_Watch":{"description":"A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a `formId` key that has the ID of the watched form and an `eventType` key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew","type":"object","properties":{"createTime":{"description":"Output only. Timestamp of when this was created.","format":"google-datetime","readOnly":true,"type":"string"},"errorType":{"description":"Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information.","readOnly":true,"enum":["ERROR_TYPE_UNSPECIFIED","PROJECT_NOT_AUTHORIZED","NO_USER_ACCESS","OTHER_ERRORS"],"type":"string"},"eventType":{"description":"Required. Which event type to watch for.","enum":["EVENT_TYPE_UNSPECIFIED","SCHEMA","RESPONSES"],"type":"string"},"expireTime":{"description":"Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.","format":"google-datetime","readOnly":true,"type":"string"},"id":{"description":"Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.","readOnly":true,"type":"string"},"state":{"description":"Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.","readOnly":true,"enum":["STATE_UNSPECIFIED","ACTIVE","SUSPENDED"],"type":"string"},"target":{"$ref":"#/components/schemas/forms_v1_WatchTarget"}}},"forms_v1_WatchTarget":{"description":"The target for notification delivery.","type":"object","properties":{"topic":{"$ref":"#/components/schemas/forms_v1_CloudPubsubTopic"}}},"forms_v1_WriteControl":{"description":"Provides control over how write requests are executed.","type":"object","properties":{"requiredRevisionId":{"description":"The revision ID of the form that the write request is applied to. If this is not the latest revision of the form, the request is not processed and returns a 400 bad request error.","type":"string"},"targetRevisionId":{"description":"The target revision ID of the form that the write request is applied to. If changes have occurred after this revision, the changes in this update request are transformed against those changes. This results in a new revision of the form that incorporates both the changes in the request and the intervening changes, with the server resolving conflicting changes. The target revision ID may only be used to write to recent versions of a form. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 (Bad Request Error). The request may be retried after reading the latest version of the form. In most cases a target revision ID remains valid for several minutes after it is read, but for frequently-edited forms this window may be shorter.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/forms.body":"See, edit, create, and delete all your Google Forms forms","https://www.googleapis.com/auth/forms.responses.readonly":"See all responses to your Google Forms forms","https://www.googleapis.com/auth/forms.body.readonly":"See all your Google Forms forms"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/forms.body","https://www.googleapis.com/auth/forms.responses.readonly"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://forms.googleapis.com/$discovery/rest?version=v1","service":"forms","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-gmail.json b/public/specs/google/google-gmail.json index 484c0531..12a05424 100644 --- a/public/specs/google/google-gmail.json +++ b/public/specs/google/google-gmail.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Gmail API","version":"v1","description":"The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels."},"servers":[{"url":"https://gmail.googleapis.com/"}],"paths":{"/gmail/v1/users/{userId}/drafts":{"get":{"operationId":"gmail.users.drafts.list","x-executor-toolPath":"gmail.users.drafts.list","tags":["Gmail API"],"description":"Lists the drafts in the user's mailbox. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeSpamTrash","in":"query","required":false,"description":"Include drafts from `SPAM` and `TRASH` in the results.","schema":{"description":"Include drafts from `SPAM` and `TRASH` in the results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","schema":{"description":"Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListDraftsResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"post":{"operationId":"gmail.users.drafts.create","x-executor-toolPath":"gmail.users.drafts.create","tags":["Gmail API"],"description":"Creates a draft with the `DRAFT` label. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/drafts/send":{"post":{"operationId":"gmail.users.drafts.send","x-executor-toolPath":"gmail.users.drafts.send","tags":["Gmail API"],"description":"Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/drafts/{id}":{"get":{"operationId":"gmail.users.drafts.get","x-executor-toolPath":"gmail.users.drafts.get","tags":["Gmail API"],"description":"Gets the specified draft. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to retrieve.","schema":{"description":"The ID of the draft to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"format","in":"query","required":false,"description":"The format to return the draft in.","schema":{"description":"The format to return the draft in.","default":"full","enum":["minimal","full","raw","metadata"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"put":{"operationId":"gmail.users.drafts.update","x-executor-toolPath":"gmail.users.drafts.update","tags":["Gmail API"],"description":"Replaces a draft's content. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to update.","schema":{"description":"The ID of the draft to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"delete":{"operationId":"gmail.users.drafts.delete","x-executor-toolPath":"gmail.users.drafts.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified draft. Does not simply trash it. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to delete.","schema":{"description":"The ID of the draft to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/history":{"get":{"operationId":"gmail.users.history.list","x-executor-toolPath":"gmail.users.history.list","tags":["Gmail API"],"description":"Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`). For more information, see [Synchronize clients with Gmail](https://developers.google.com/workspace/gmail/api/guides/sync).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"historyTypes","in":"query","required":false,"description":"History types to be returned by the function","schema":{"type":"array","items":{"description":"History types to be returned by the function","enum":["messageAdded","messageDeleted","labelAdded","labelRemoved"],"type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"labelId","in":"query","required":false,"description":"Only return messages with a label matching the ID.","schema":{"description":"Only return messages with a label matching the ID.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startHistoryId","in":"query","required":false,"description":"Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request.","schema":{"description":"Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListHistoryResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/labels":{"get":{"operationId":"gmail.users.labels.list","x-executor-toolPath":"gmail.users.labels.list","tags":["Gmail API"],"description":"Lists all labels in the user's mailbox. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListLabelsResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"post":{"operationId":"gmail.users.labels.create","x-executor-toolPath":"gmail.users.labels.create","tags":["Gmail API"],"description":"Creates a label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/labels/{id}":{"get":{"operationId":"gmail.users.labels.get","x-executor-toolPath":"gmail.users.labels.get","tags":["Gmail API"],"description":"Gets the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to retrieve.","schema":{"description":"The ID of the label to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"put":{"operationId":"gmail.users.labels.update","x-executor-toolPath":"gmail.users.labels.update","tags":["Gmail API"],"description":"Updates the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to update.","schema":{"description":"The ID of the label to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"delete":{"operationId":"gmail.users.labels.delete","x-executor-toolPath":"gmail.users.labels.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified label and removes it from any messages and threads that it's applied to. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to delete.","schema":{"description":"The ID of the label to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"patch":{"operationId":"gmail.users.labels.patch","x-executor-toolPath":"gmail.users.labels.patch","tags":["Gmail API"],"description":"Patch the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to update.","schema":{"description":"The ID of the label to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages":{"get":{"operationId":"gmail.users.messages.list","x-executor-toolPath":"gmail.users.messages.list","tags":["Gmail API"],"description":"Lists the messages in the user's mailbox. For more information, see [List Gmail messages](https://developers.google.com/workspace/gmail/api/guides/list-messages).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeSpamTrash","in":"query","required":false,"description":"Include messages from `SPAM` and `TRASH` in the results.","schema":{"description":"Include messages from `SPAM` and `TRASH` in the results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"labelIds","in":"query","required":false,"description":"Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads).","schema":{"type":"array","items":{"description":"Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads).","type":"string"}},"style":"form","explode":true},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","schema":{"description":"Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListMessagesResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"post":{"operationId":"gmail.users.messages.insert","x-executor-toolPath":"gmail.users.messages.insert","tags":["Gmail API"],"description":"Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"receivedTime","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/batchDelete":{"post":{"operationId":"gmail.users.messages.batchDelete","x-executor-toolPath":"gmail.users.messages.batchDelete","tags":["Gmail API"],"description":"Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_BatchDeleteMessagesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/batchModify":{"post":{"operationId":"gmail.users.messages.batchModify","x-executor-toolPath":"gmail.users.messages.batchModify","tags":["Gmail API"],"description":"Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_BatchModifyMessagesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/import":{"post":{"operationId":"gmail.users.messages.import","x-executor-toolPath":"gmail.users.messages.import","tags":["Gmail API"],"description":"Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note that the maximum size of the message is 150 MB.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"dateHeader","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"neverMarkSpam","in":"query","required":false,"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","schema":{"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"processForCalendar","in":"query","required":false,"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","schema":{"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/send":{"post":{"operationId":"gmail.users.messages.send","x-executor-toolPath":"gmail.users.messages.send","tags":["Gmail API"],"description":"Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}":{"get":{"operationId":"gmail.users.messages.get","x-executor-toolPath":"gmail.users.messages.get","tags":["Gmail API"],"description":"Gets the specified message.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).","schema":{"description":"The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"format","in":"query","required":false,"description":"The format to return the message in.","schema":{"description":"The format to return the message in.","default":"full","enum":["minimal","full","raw","metadata"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"metadataHeaders","in":"query","required":false,"description":"When given and format is `METADATA`, only include headers specified.","schema":{"type":"array","items":{"description":"When given and format is `METADATA`, only include headers specified.","type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"delete":{"operationId":"gmail.users.messages.delete","x-executor-toolPath":"gmail.users.messages.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to delete.","schema":{"description":"The ID of the message to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}/modify":{"post":{"operationId":"gmail.users.messages.modify","x-executor-toolPath":"gmail.users.messages.modify","tags":["Gmail API"],"description":"Modifies the labels and the Classification Label values on the specified message. For administrators modifying message for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to modify.","schema":{"description":"The ID of the message to modify.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ModifyMessageRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}/trash":{"post":{"operationId":"gmail.users.messages.trash","x-executor-toolPath":"gmail.users.messages.trash","tags":["Gmail API"],"description":"Moves the specified message to the trash.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to Trash.","schema":{"description":"The ID of the message to Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}/untrash":{"post":{"operationId":"gmail.users.messages.untrash","x-executor-toolPath":"gmail.users.messages.untrash","tags":["Gmail API"],"description":"Removes the specified message from the trash.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to remove from Trash.","schema":{"description":"The ID of the message to remove from Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}":{"get":{"operationId":"gmail.users.messages.attachments.get","x-executor-toolPath":"gmail.users.messages.attachments.get","tags":["Gmail API"],"description":"Gets the specified message attachment.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"messageId","in":"path","required":true,"description":"The ID of the message containing the attachment.","schema":{"description":"The ID of the message containing the attachment.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the attachment.","schema":{"description":"The ID of the attachment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_MessagePartBody"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/profile":{"get":{"operationId":"gmail.users.getProfile","x-executor-toolPath":"gmail.users.getProfile","tags":["Gmail API"],"description":"Gets the current user's Gmail profile.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Profile"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/settings/autoForwarding":{"get":{"operationId":"gmail.users.settings.getAutoForwarding","x-executor-toolPath":"gmail.users.settings.getAutoForwarding","tags":["Gmail API"],"description":"Gets the auto-forwarding setting for the specified account. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_AutoForwarding"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/identities":{"get":{"operationId":"gmail.users.settings.cse.identities.list","x-executor-toolPath":"gmail.users.settings.cse.identities.list","tags":["Gmail API"],"description":"Lists the client-side encrypted identities for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The number of identities to return. If not provided, the page size will default to 20 entries.","schema":{"description":"The number of identities to return. If not provided, the page size will default to 20 entries.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.","schema":{"description":"Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListCseIdentitiesResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.cse.identities.create","x-executor-toolPath":"gmail.users.settings.cse.identities.create","tags":["Gmail API"],"description":"Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}":{"get":{"operationId":"gmail.users.settings.cse.identities.get","x-executor-toolPath":"gmail.users.settings.cse.identities.get","tags":["Gmail API"],"description":"Retrieves a client-side encryption identity configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"cseEmailAddress","in":"path","required":true,"description":"The primary email address associated with the client-side encryption identity configuration that's retrieved.","schema":{"description":"The primary email address associated with the client-side encryption identity configuration that's retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"delete":{"operationId":"gmail.users.settings.cse.identities.delete","x-executor-toolPath":"gmail.users.settings.cse.identities.delete","tags":["Gmail API"],"description":"Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"cseEmailAddress","in":"path","required":true,"description":"The primary email address associated with the client-side encryption identity configuration that's removed.","schema":{"description":"The primary email address associated with the client-side encryption identity configuration that's removed.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}":{"patch":{"operationId":"gmail.users.settings.cse.identities.patch","x-executor-toolPath":"gmail.users.settings.cse.identities.patch","tags":["Gmail API"],"description":"Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887). For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"emailAddress","in":"path","required":true,"description":"The email address of the client-side encryption identity to update.","schema":{"description":"The email address of the client-side encryption identity to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs":{"get":{"operationId":"gmail.users.settings.cse.keypairs.list","x-executor-toolPath":"gmail.users.settings.cse.keypairs.list","tags":["Gmail API"],"description":"Lists client-side encryption key pairs for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The number of key pairs to return. If not provided, the page size will default to 20 entries.","schema":{"description":"The number of key pairs to return. If not provided, the page size will default to 20 entries.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.","schema":{"description":"Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListCseKeyPairsResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.cse.keypairs.create","x-executor-toolPath":"gmail.users.settings.cse.keypairs.create","tags":["Gmail API"],"description":"Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"chainValidation","in":"query","required":false,"description":"The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation checks. When unspecified, this parameter defaults to `all`.","schema":{"description":"The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation checks. When unspecified, this parameter defaults to `all`.","default":"all","enum":["all","none"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}":{"get":{"operationId":"gmail.users.settings.cse.keypairs.get","x-executor-toolPath":"gmail.users.settings.cse.keypairs.get","tags":["Gmail API"],"description":"Retrieves an existing client-side encryption key pair. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to retrieve.","schema":{"description":"The identifier of the key pair to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable":{"post":{"operationId":"gmail.users.settings.cse.keypairs.disable","x-executor-toolPath":"gmail.users.settings.cse.keypairs.disable","tags":["Gmail API"],"description":"Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to turn off.","schema":{"description":"The identifier of the key pair to turn off.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_DisableCseKeyPairRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable":{"post":{"operationId":"gmail.users.settings.cse.keypairs.enable","x-executor-toolPath":"gmail.users.settings.cse.keypairs.enable","tags":["Gmail API"],"description":"Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to turn on.","schema":{"description":"The identifier of the key pair to turn on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_EnableCseKeyPairRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate":{"post":{"operationId":"gmail.users.settings.cse.keypairs.obliterate","x-executor-toolPath":"gmail.users.settings.cse.keypairs.obliterate","tags":["Gmail API"],"description":"Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to obliterate.","schema":{"description":"The identifier of the key pair to obliterate.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ObliterateCseKeyPairRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/filters":{"get":{"operationId":"gmail.users.settings.filters.list","x-executor-toolPath":"gmail.users.settings.filters.list","tags":["Gmail API"],"description":"Lists the message filters of a Gmail user. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListFiltersResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.filters.create","x-executor-toolPath":"gmail.users.settings.filters.create","tags":["Gmail API"],"description":"Creates a filter. Note: you can only create a maximum of 1,000 filters. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/filters/{id}":{"get":{"operationId":"gmail.users.settings.filters.get","x-executor-toolPath":"gmail.users.settings.filters.get","tags":["Gmail API"],"description":"Gets a filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the filter to be fetched.","schema":{"description":"The ID of the filter to be fetched.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"delete":{"operationId":"gmail.users.settings.filters.delete","x-executor-toolPath":"gmail.users.settings.filters.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the filter to be deleted.","schema":{"description":"The ID of the filter to be deleted.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/forwardingAddresses":{"get":{"operationId":"gmail.users.settings.forwardingAddresses.list","x-executor-toolPath":"gmail.users.settings.forwardingAddresses.list","tags":["Gmail API"],"description":"Lists the forwarding addresses for the specified account. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListForwardingAddressesResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}":{"get":{"operationId":"gmail.users.settings.forwardingAddresses.get","x-executor-toolPath":"gmail.users.settings.forwardingAddresses.get","tags":["Gmail API"],"description":"Gets the specified forwarding address. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"forwardingEmail","in":"path","required":true,"description":"The forwarding address to be retrieved.","schema":{"description":"The forwarding address to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ForwardingAddress"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/imap":{"get":{"operationId":"gmail.users.settings.getImap","x-executor-toolPath":"gmail.users.settings.getImap","tags":["Gmail API"],"description":"Gets IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ImapSettings"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updateImap","x-executor-toolPath":"gmail.users.settings.updateImap","tags":["Gmail API"],"description":"Updates IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ImapSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ImapSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/language":{"get":{"operationId":"gmail.users.settings.getLanguage","x-executor-toolPath":"gmail.users.settings.getLanguage","tags":["Gmail API"],"description":"Gets language settings. For more information, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_LanguageSettings"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updateLanguage","x-executor-toolPath":"gmail.users.settings.updateLanguage","tags":["Gmail API"],"description":"Updates language settings. For more information, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_LanguageSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_LanguageSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/pop":{"get":{"operationId":"gmail.users.settings.getPop","x-executor-toolPath":"gmail.users.settings.getPop","tags":["Gmail API"],"description":"Gets POP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_PopSettings"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updatePop","x-executor-toolPath":"gmail.users.settings.updatePop","tags":["Gmail API"],"description":"Updates POP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_PopSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_PopSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs":{"get":{"operationId":"gmail.users.settings.sendAs.list","x-executor-toolPath":"gmail.users.settings.sendAs.list","tags":["Gmail API"],"description":"Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom \"from\" aliases. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListSendAsResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}":{"get":{"operationId":"gmail.users.settings.sendAs.get","x-executor-toolPath":"gmail.users.settings.sendAs.get","tags":["Gmail API"],"description":"Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The send-as alias to be retrieved.","schema":{"description":"The send-as alias to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.sendAs.update","x-executor-toolPath":"gmail.users.settings.sendAs.update","tags":["Gmail API"],"description":"Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings). Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The send-as alias to be updated.","schema":{"description":"The send-as alias to be updated.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]},"patch":{"operationId":"gmail.users.settings.sendAs.patch","x-executor-toolPath":"gmail.users.settings.sendAs.patch","tags":["Gmail API"],"description":"Patch the specified send-as alias. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The send-as alias to be updated.","schema":{"description":"The send-as alias to be updated.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo":{"get":{"operationId":"gmail.users.settings.sendAs.smimeInfo.list","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.list","tags":["Gmail API"],"description":"Lists S/MIME configs for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListSmimeInfoResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.sendAs.smimeInfo.insert","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.insert","tags":["Gmail API"],"description":"Insert (upload) the given S/MIME config for the specified send-as alias. Note that `pkcs12` format is required for the key. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}":{"get":{"operationId":"gmail.users.settings.sendAs.smimeInfo.get","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.get","tags":["Gmail API"],"description":"Gets the specified S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The immutable ID for the SmimeInfo.","schema":{"description":"The immutable ID for the SmimeInfo.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"delete":{"operationId":"gmail.users.settings.sendAs.smimeInfo.delete","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.delete","tags":["Gmail API"],"description":"Deletes the specified S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The immutable ID for the SmimeInfo.","schema":{"description":"The immutable ID for the SmimeInfo.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault":{"post":{"operationId":"gmail.users.settings.sendAs.smimeInfo.setDefault","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.setDefault","tags":["Gmail API"],"description":"Sets the default S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The immutable ID for the SmimeInfo.","schema":{"description":"The immutable ID for the SmimeInfo.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/vacation":{"get":{"operationId":"gmail.users.settings.getVacation","x-executor-toolPath":"gmail.users.settings.getVacation","tags":["Gmail API"],"description":"Gets vacation responder settings. For more information, see [Manage vacation settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/vacation_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_VacationSettings"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updateVacation","x-executor-toolPath":"gmail.users.settings.updateVacation","tags":["Gmail API"],"description":"Updates vacation responder settings. For more information, see [Manage vacation settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/vacation_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_VacationSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_VacationSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/stop":{"post":{"operationId":"gmail.users.stop","x-executor-toolPath":"gmail.users.stop","tags":["Gmail API"],"description":"Turn off push notification delivery for the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads":{"get":{"operationId":"gmail.users.threads.list","x-executor-toolPath":"gmail.users.threads.list","tags":["Gmail API"],"description":"Lists the threads in the user's mailbox. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeSpamTrash","in":"query","required":false,"description":"Include threads from `SPAM` and `TRASH` in the results.","schema":{"description":"Include threads from `SPAM` and `TRASH` in the results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"labelIds","in":"query","required":false,"description":"Only return threads with labels that match all of the specified label IDs.","schema":{"type":"array","items":{"description":"Only return threads with labels that match all of the specified label IDs.","type":"string"}},"style":"form","explode":true},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","schema":{"description":"Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListThreadsResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}":{"get":{"operationId":"gmail.users.threads.get","x-executor-toolPath":"gmail.users.threads.get","tags":["Gmail API"],"description":"Gets the specified thread. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to retrieve.","schema":{"description":"The ID of the thread to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"format","in":"query","required":false,"description":"The format to return the messages in.","schema":{"description":"The format to return the messages in.","default":"full","enum":["full","metadata","minimal"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"metadataHeaders","in":"query","required":false,"description":"When given and format is METADATA, only include headers specified.","schema":{"type":"array","items":{"description":"When given and format is METADATA, only include headers specified.","type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]},"delete":{"operationId":"gmail.users.threads.delete","x-executor-toolPath":"gmail.users.threads.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer `threads.trash` instead. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"ID of the Thread to delete.","schema":{"description":"ID of the Thread to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}/modify":{"post":{"operationId":"gmail.users.threads.modify","x-executor-toolPath":"gmail.users.threads.modify","tags":["Gmail API"],"description":"Modifies the labels applied to the thread. This applies to all messages in the thread. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to modify.","schema":{"description":"The ID of the thread to modify.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ModifyThreadRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}/trash":{"post":{"operationId":"gmail.users.threads.trash","x-executor-toolPath":"gmail.users.threads.trash","tags":["Gmail API"],"description":"Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to Trash.","schema":{"description":"The ID of the thread to Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}/untrash":{"post":{"operationId":"gmail.users.threads.untrash","x-executor-toolPath":"gmail.users.threads.untrash","tags":["Gmail API"],"description":"Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to remove from Trash.","schema":{"description":"The ID of the thread to remove from Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/watch":{"post":{"operationId":"gmail.users.watch","x-executor-toolPath":"gmail.users.watch","tags":["Gmail API"],"description":"Set up or update a push notification watch on the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_WatchRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_WatchResponse"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/drafts":{"post":{"operationId":"gmail.users.drafts.createMedia","x-executor-toolPath":"gmail.users.drafts.createMedia","tags":["Gmail API"],"description":"Creates a draft with the `DRAFT` label. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/drafts/send":{"post":{"operationId":"gmail.users.drafts.sendMedia","x-executor-toolPath":"gmail.users.drafts.sendMedia","tags":["Gmail API"],"description":"Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/drafts/{id}":{"put":{"operationId":"gmail.users.drafts.updateMedia","x-executor-toolPath":"gmail.users.drafts.updateMedia","tags":["Gmail API"],"description":"Replaces a draft's content. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to update.","schema":{"description":"The ID of the draft to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/messages":{"post":{"operationId":"gmail.users.messages.insertMedia","x-executor-toolPath":"gmail.users.messages.insertMedia","tags":["Gmail API"],"description":"Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"receivedTime","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/messages/import":{"post":{"operationId":"gmail.users.messages.importMedia","x-executor-toolPath":"gmail.users.messages.importMedia","tags":["Gmail API"],"description":"Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note that the maximum size of the message is 150 MB. (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"dateHeader","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"neverMarkSpam","in":"query","required":false,"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","schema":{"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"processForCalendar","in":"query","required":false,"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","schema":{"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/messages/send":{"post":{"operationId":"gmail.users.messages.sendMedia","x-executor-toolPath":"gmail.users.messages.sendMedia","tags":["Gmail API"],"description":"Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}}},"components":{"schemas":{"gmail_v1_AutoForwarding":{"description":"Auto-forwarding settings for an account.","type":"object","properties":{"disposition":{"description":"The state that a message should be left in after it has been forwarded.","enum":["dispositionUnspecified","leaveInInbox","archive","trash","markRead"],"type":"string"},"emailAddress":{"description":"Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.","type":"string"},"enabled":{"description":"Whether all incoming mail is automatically forwarded to another address.","type":"boolean"}}},"gmail_v1_BatchDeleteMessagesRequest":{"type":"object","properties":{"ids":{"description":"The IDs of the messages to delete.","type":"array","items":{"type":"string"}}}},"gmail_v1_BatchModifyMessagesRequest":{"type":"object","properties":{"addClassificationLabels":{"description":"A list of Classification Label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelValue"}},"addLabelIds":{"description":"A list of label IDs to add to messages.","type":"array","items":{"type":"string"}},"ids":{"description":"The IDs of the messages to modify. There is a limit of 1000 ids per request.","type":"array","items":{"type":"string"}},"removeClassificationLabelIds":{"description":"A list of Classification Label values to remove from messages.","type":"array","items":{"type":"string"}},"removeLabelIds":{"description":"A list of label IDs to remove from messages.","type":"array","items":{"type":"string"}}}},"gmail_v1_ClassificationLabelFieldValue":{"description":"Field values for a classification label.","type":"object","properties":{"fieldId":{"description":"Required. The field ID for the Classification Label Value. Maps to the ID field of the Google Drive `Label.Field` object.","type":"string"},"selection":{"description":"Selection choice ID for the selection option. Should only be set if the field type is `SELECTION` in the Google Drive `Label.Field` object. Maps to the id field of the Google Drive `Label.Field.SelectionOptions` resource.","type":"string"}}},"gmail_v1_ClassificationLabelValue":{"description":"Classification Labels applied to the email message. Classification Labels are different from Gmail inbox labels. Only used for Google Workspace accounts. [Learn more about classification labels](https://support.google.com/a/answer/9292382).","type":"object","properties":{"fields":{"description":"Field values for the given classification label ID.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelFieldValue"}},"labelId":{"description":"Required. The canonical or raw alphanumeric classification label ID. Maps to the ID field of the Google Drive Label resource.","type":"string"}}},"gmail_v1_CseIdentity":{"description":"The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","type":"object","properties":{"emailAddress":{"description":"The email address for the sending identity. The email address must be the primary email address of the authenticated user.","type":"string"},"primaryKeyPairId":{"description":"If a key pair is associated, the ID of the key pair, CseKeyPair.","type":"string"},"signAndEncryptKeyPairs":{"$ref":"#/components/schemas/gmail_v1_SignAndEncryptKeyPairs"}}},"gmail_v1_CseKeyPair":{"description":"A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","type":"object","properties":{"disableTime":{"description":"Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.","format":"google-datetime","readOnly":true,"type":"string"},"enablementState":{"description":"Output only. The current state of the key pair.","readOnly":true,"enum":["stateUnspecified","enabled","disabled"],"type":"string"},"keyPairId":{"description":"Output only. The immutable ID for the client-side encryption S/MIME key pair.","readOnly":true,"type":"string"},"pem":{"description":"Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.","readOnly":true,"type":"string"},"pkcs7":{"description":"Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.","type":"string"},"privateKeyMetadata":{"description":"Metadata for instances of this key pair's private key.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_CsePrivateKeyMetadata"}},"subjectEmailAddresses":{"description":"Output only. The email address identities that are specified on the leaf certificate.","readOnly":true,"type":"array","items":{"type":"string"}}}},"gmail_v1_CsePrivateKeyMetadata":{"description":"Metadata for a private key instance.","type":"object","properties":{"hardwareKeyMetadata":{"$ref":"#/components/schemas/gmail_v1_HardwareKeyMetadata"},"kaclsKeyMetadata":{"$ref":"#/components/schemas/gmail_v1_KaclsKeyMetadata"},"privateKeyMetadataId":{"description":"Output only. The immutable ID for the private key metadata instance.","readOnly":true,"type":"string"}}},"gmail_v1_Delegate":{"description":"Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See \"Set up mail delegation\" for more information about delegates.","type":"object","properties":{"delegateEmail":{"description":"The email address of the delegate.","type":"string"},"verificationStatus":{"description":"Indicates whether this address has been verified and can act as a delegate for the account. Read-only.","enum":["verificationStatusUnspecified","accepted","pending","rejected","expired"],"type":"string"}}},"gmail_v1_DisableCseKeyPairRequest":{"description":"Requests to turn off a client-side encryption key pair.","type":"object"},"gmail_v1_Draft":{"description":"A draft email in the user's mailbox.","type":"object","properties":{"id":{"description":"The immutable ID of the draft.","type":"string"},"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_EnableCseKeyPairRequest":{"description":"Requests to turn on a client-side encryption key pair.","type":"object"},"gmail_v1_Filter":{"description":"Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.","type":"object","properties":{"action":{"$ref":"#/components/schemas/gmail_v1_FilterAction"},"criteria":{"$ref":"#/components/schemas/gmail_v1_FilterCriteria"},"id":{"description":"The server assigned ID of the filter.","type":"string"}}},"gmail_v1_FilterAction":{"description":"A set of actions to perform on a message.","type":"object","properties":{"addLabelIds":{"description":"List of labels to add to the message.","type":"array","items":{"type":"string"}},"forward":{"description":"Email address that the message should be forwarded to. This effectively redirects the message to the address specified in this field, maintaining the original sender in the \"From\" field.","type":"string"},"removeLabelIds":{"description":"List of labels to remove from the message.","type":"array","items":{"type":"string"}}}},"gmail_v1_FilterCriteria":{"description":"Message matching criteria.","type":"object","properties":{"excludeChats":{"description":"Whether the response should exclude chats.","type":"boolean"},"from":{"description":"The sender's display name or email address.","type":"string"},"hasAttachment":{"description":"Whether the message has any attachment.","type":"boolean"},"negatedQuery":{"description":"Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","type":"string"},"query":{"description":"Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","type":"string"},"size":{"description":"The size of the entire RFC822 message in bytes, including all headers and attachments.","format":"int32","type":"integer"},"sizeComparison":{"description":"How the message size in bytes should be in relation to the size field.","enum":["unspecified","smaller","larger"],"type":"string"},"subject":{"description":"Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.","type":"string"},"to":{"description":"The recipient's display name or email address. Includes recipients in the \"to\", \"cc\", and \"bcc\" header fields. You can use simply the local part of the email address. For example, \"example\" and \"example@\" both match \"example@gmail.com\". This field is case-insensitive.","type":"string"}}},"gmail_v1_ForwardingAddress":{"description":"Settings for a forwarding address.","type":"object","properties":{"forwardingEmail":{"description":"An email address to which messages can be forwarded.","type":"string"},"verificationStatus":{"description":"Indicates whether this address has been verified and is usable for forwarding. Read-only.","enum":["verificationStatusUnspecified","accepted","pending"],"type":"string"}}},"gmail_v1_HardwareKeyMetadata":{"description":"Metadata for hardware keys. If [hardware key encryption](https://support.google.com/a/answer/14153163) is set up for the Google Workspace organization, users can optionally store their private key on their smart card and use it to sign and decrypt email messages in Gmail by inserting their smart card into a reader attached to their Windows device.","type":"object","properties":{"description":{"description":"Description about the hardware key.","type":"string"}}},"gmail_v1_History":{"description":"A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.","type":"object","properties":{"id":{"description":"The mailbox sequence ID.","format":"uint64","type":"string"},"labelsAdded":{"description":"Labels added to messages in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryLabelAdded"}},"labelsRemoved":{"description":"Labels removed from messages in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryLabelRemoved"}},"messages":{"description":"List of messages changed in this history record. The fields for specific change types, such as `messagesAdded` may duplicate messages in this field. We recommend using the specific change-type fields instead of this.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Message"}},"messagesAdded":{"description":"Messages added to the mailbox in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryMessageAdded"}},"messagesDeleted":{"description":"Messages deleted (not Trashed) from the mailbox in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryMessageDeleted"}}}},"gmail_v1_HistoryLabelAdded":{"type":"object","properties":{"labelIds":{"description":"Label IDs added to the message.","type":"array","items":{"type":"string"}},"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_HistoryLabelRemoved":{"type":"object","properties":{"labelIds":{"description":"Label IDs removed from the message.","type":"array","items":{"type":"string"}},"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_HistoryMessageAdded":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_HistoryMessageDeleted":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_ImapSettings":{"description":"IMAP settings for an account.","type":"object","properties":{"autoExpunge":{"description":"If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.","type":"boolean"},"enabled":{"description":"Whether IMAP is enabled for the account.","type":"boolean"},"expungeBehavior":{"description":"The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.","enum":["expungeBehaviorUnspecified","archive","trash","deleteForever"],"type":"string"},"maxFolderSize":{"description":"An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.","format":"int32","type":"integer"}}},"gmail_v1_KaclsKeyMetadata":{"description":"Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference).","type":"object","properties":{"kaclsData":{"description":"Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.","type":"string"},"kaclsUri":{"description":"The URI of the key access control list service that manages the private key.","type":"string"}}},"gmail_v1_Label":{"description":"Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000.","type":"object","properties":{"color":{"$ref":"#/components/schemas/gmail_v1_LabelColor"},"id":{"description":"The immutable ID of the label.","type":"string"},"labelListVisibility":{"description":"The visibility of the label in the label list in the Gmail web interface.","enum":["labelShow","labelShowIfUnread","labelHide"],"type":"string"},"messageListVisibility":{"description":"The visibility of messages with this label in the message list in the Gmail web interface.","enum":["show","hide"],"type":"string"},"messagesTotal":{"description":"The total number of messages with the label.","format":"int32","type":"integer"},"messagesUnread":{"description":"The number of unread messages with the label.","format":"int32","type":"integer"},"name":{"description":"The display name of the label.","type":"string"},"threadsTotal":{"description":"The total number of threads with the label.","format":"int32","type":"integer"},"threadsUnread":{"description":"The number of unread threads with the label.","format":"int32","type":"integer"},"type":{"description":"The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the `INBOX` and `UNREAD` labels from messages and threads, but cannot apply or remove the `DRAFTS` or `SENT` labels from messages or threads.","enum":["system","user"],"type":"string"}}},"gmail_v1_LabelColor":{"type":"object","properties":{"backgroundColor":{"description":"The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \\#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \\#083018","type":"string"},"textColor":{"description":"The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \\#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \\#083018","type":"string"}}},"gmail_v1_LanguageSettings":{"description":"Language settings for an account. These settings correspond to the \"Language settings\" feature in the web interface.","type":"object","properties":{"displayLanguage":{"description":"The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the \"Language\" dropdown in the Gmail settings for all available options, as described in the language settings help article. For a table of sample values, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).","type":"string"}}},"gmail_v1_ListCseIdentitiesResponse":{"type":"object","properties":{"cseIdentities":{"description":"One page of the list of CSE identities configured for the user.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}},"nextPageToken":{"description":"Pagination token to be passed to a subsequent ListCseIdentities call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain.","type":"string"}}},"gmail_v1_ListCseKeyPairsResponse":{"type":"object","properties":{"cseKeyPairs":{"description":"One page of the list of CSE key pairs installed for the user.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}},"nextPageToken":{"description":"Pagination token to be passed to a subsequent ListCseKeyPairs call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.","type":"string"}}},"gmail_v1_ListDelegatesResponse":{"description":"Response for the ListDelegates method.","type":"object","properties":{"delegates":{"description":"List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Delegate"}}}},"gmail_v1_ListDraftsResponse":{"type":"object","properties":{"drafts":{"description":"List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The [`messages.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/messages/get) method can fetch additional message details.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Draft"}},"nextPageToken":{"description":"Token to retrieve the next page of results in the list.","type":"string"},"resultSizeEstimate":{"description":"Estimated total number of results.","format":"uint32","type":"integer"}}},"gmail_v1_ListFiltersResponse":{"description":"Response for the ListFilters method.","type":"object","properties":{"filter":{"description":"List of a user's filters.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}},"gmail_v1_ListForwardingAddressesResponse":{"description":"Response for the ListForwardingAddresses method.","type":"object","properties":{"forwardingAddresses":{"description":"List of addresses that may be used for forwarding.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ForwardingAddress"}}}},"gmail_v1_ListHistoryResponse":{"type":"object","properties":{"history":{"description":"List of history records. Any `messages` contained in the response will typically only have `id` and `threadId` fields populated.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_History"}},"historyId":{"description":"The ID of the mailbox's current history record.","format":"uint64","type":"string"},"nextPageToken":{"description":"Page token to retrieve the next page of results in the list.","type":"string"}}},"gmail_v1_ListLabelsResponse":{"type":"object","properties":{"labels":{"description":"List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`labels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/labels/get) method can fetch additional label details.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"gmail_v1_ListMessagesResponse":{"type":"object","properties":{"messages":{"description":"List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Message"}},"nextPageToken":{"description":"Token to retrieve the next page of results in the list.","type":"string"},"resultSizeEstimate":{"description":"Estimated total number of results.","format":"uint32","type":"integer"}}},"gmail_v1_ListSendAsResponse":{"description":"Response for the ListSendAs method.","type":"object","properties":{"sendAs":{"description":"List of send-as aliases.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}},"gmail_v1_ListSmimeInfoResponse":{"type":"object","properties":{"smimeInfo":{"description":"List of SmimeInfo.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}},"gmail_v1_ListThreadsResponse":{"type":"object","properties":{"nextPageToken":{"description":"Page token to retrieve the next page of results in the list.","type":"string"},"resultSizeEstimate":{"description":"Estimated total number of results.","format":"uint32","type":"integer"},"threads":{"description":"List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the [`threads.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/threads/get) method.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}},"gmail_v1_Message":{"description":"An email message.","type":"object","properties":{"classificationLabelValues":{"description":"Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts. There's a limit of 20 Classification Label values per request. If the Classification Label values exceeds the maximum allowed number, the request fails.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelValue"}},"historyId":{"description":"The ID of the last history record that modified this message.","format":"uint64","type":"string"},"id":{"description":"The immutable ID of the message.","type":"string"},"internalDate":{"description":"The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.","format":"int64","type":"string"},"labelIds":{"description":"List of IDs of labels applied to this message.","type":"array","items":{"type":"string"}},"payload":{"$ref":"#/components/schemas/gmail_v1_MessagePart"},"raw":{"description":"The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update","format":"byte","type":"string"},"sizeEstimate":{"description":"Estimated size in bytes of the message.","format":"int32","type":"integer"},"snippet":{"description":"A short part of the message text.","type":"string"},"threadId":{"description":"The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. ","type":"string"}}},"gmail_v1_MessagePart":{"description":"A single MIME message part.","type":"object","properties":{"body":{"$ref":"#/components/schemas/gmail_v1_MessagePartBody"},"filename":{"description":"The filename of the attachment. Only present if this message part represents an attachment.","type":"string"},"headers":{"description":"List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_MessagePartHeader"}},"mimeType":{"description":"The MIME type of the message part.","type":"string"},"partId":{"description":"The immutable ID of the message part.","type":"string"},"parts":{"description":"The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_MessagePart"}}}},"gmail_v1_MessagePartBody":{"description":"The body of a single MIME message part.","type":"object","properties":{"attachmentId":{"description":"When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.","type":"string"},"data":{"description":"The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.","format":"byte","type":"string"},"size":{"description":"Number of bytes for the message part data (encoding notwithstanding).","format":"int32","type":"integer"}}},"gmail_v1_MessagePartHeader":{"type":"object","properties":{"name":{"description":"The name of the header before the `:` separator. For example, `To`.","type":"string"},"value":{"description":"The value of the header after the `:` separator. For example, `someuser@example.com`.","type":"string"}}},"gmail_v1_ModifyMessageRequest":{"type":"object","properties":{"addClassificationLabels":{"description":"A list of classification label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelValue"}},"addLabelIds":{"description":"A list of IDs of labels to add to this message. You can add up to 100 labels with each update.","type":"array","items":{"type":"string"}},"removeClassificationLabelIds":{"description":"A list of Classification Label values to remove from this message.","type":"array","items":{"type":"string"}},"removeLabelIds":{"description":"A list IDs of labels to remove from this message. You can remove up to 100 labels with each update.","type":"array","items":{"type":"string"}}}},"gmail_v1_ModifyThreadRequest":{"type":"object","properties":{"addLabelIds":{"description":"A list of IDs of labels to add to this thread. You can add up to 100 labels with each update.","type":"array","items":{"type":"string"}},"removeLabelIds":{"description":"A list of IDs of labels to remove from this thread. You can remove up to 100 labels with each update.","type":"array","items":{"type":"string"}}}},"gmail_v1_ObliterateCseKeyPairRequest":{"description":"Request to obliterate a CSE key pair.","type":"object"},"gmail_v1_PopSettings":{"description":"POP settings for an account.","type":"object","properties":{"accessWindow":{"description":"The range of messages which are accessible via POP.","enum":["accessWindowUnspecified","disabled","fromNowOn","allMail"],"type":"string"},"disposition":{"description":"The action that will be executed on a message after it has been fetched via POP.","enum":["dispositionUnspecified","leaveInInbox","archive","trash","markRead"],"type":"string"}}},"gmail_v1_Profile":{"description":"Profile for a Gmail user.","type":"object","properties":{"emailAddress":{"description":"The user's email address.","type":"string"},"historyId":{"description":"The ID of the mailbox's current history record.","format":"uint64","type":"string"},"messagesTotal":{"description":"The total number of messages in the mailbox.","format":"int32","type":"integer"},"threadsTotal":{"description":"The total number of threads in the mailbox.","format":"int32","type":"integer"}}},"gmail_v1_SendAs":{"description":"Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom \"from\" address. Send-as aliases correspond to the \"Send Mail As\" feature in the web interface. The send-as alias must be a valid email address.","type":"object","properties":{"displayName":{"description":"A name that appears in the \"From:\" header for mail sent using this alias. For custom \"from\" addresses, when this is empty, Gmail will populate the \"From:\" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.","type":"string"},"isDefault":{"description":"Whether this address is selected as the default \"From:\" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.","type":"boolean"},"isPrimary":{"description":"Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.","type":"boolean"},"replyToAddress":{"description":"An optional email address that is included in a \"Reply-To:\" header for mail sent using this alias. If this is empty, Gmail will not generate a \"Reply-To:\" header.","type":"string"},"sendAsEmail":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias. This is read-only for all operations except create.","type":"string"},"signature":{"description":"An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.","type":"string"},"smtpMsa":{"$ref":"#/components/schemas/gmail_v1_SmtpMsa"},"treatAsAlias":{"description":"Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom \"from\" aliases.","type":"boolean"},"verificationStatus":{"description":"Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom \"from\" aliases.","enum":["verificationStatusUnspecified","accepted","pending"],"type":"string"}}},"gmail_v1_SignAndEncryptKeyPairs":{"description":"The configuration of a CSE identity that uses different key pairs for signing and encryption.","type":"object","properties":{"encryptionKeyPairId":{"description":"The ID of the CseKeyPair that encrypts signed outgoing mail.","type":"string"},"signingKeyPairId":{"description":"The ID of the CseKeyPair that signs outgoing mail.","type":"string"}}},"gmail_v1_SmimeInfo":{"description":"An S/MIME email config.","type":"object","properties":{"encryptedKeyPassword":{"description":"Encrypted key password, when key is encrypted.","type":"string"},"expiration":{"description":"When the certificate expires (in milliseconds since epoch).","format":"int64","type":"string"},"id":{"description":"The immutable ID for the SmimeInfo.","type":"string"},"isDefault":{"description":"Whether this SmimeInfo is the default one for this user's send-as address.","type":"boolean"},"issuerCn":{"description":"The S/MIME certificate issuer's common name.","type":"string"},"pem":{"description":"PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).","type":"string"},"pkcs12":{"description":"PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.","format":"byte","type":"string"}}},"gmail_v1_SmtpMsa":{"description":"Configuration for communication with an SMTP service.","type":"object","properties":{"host":{"description":"The hostname of the SMTP service. Required.","type":"string"},"password":{"description":"The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.","type":"string"},"port":{"description":"The port of the SMTP service. Required.","format":"int32","type":"integer"},"securityMode":{"description":"The protocol that will be used to secure communication with the SMTP service. Required.","enum":["securityModeUnspecified","none","ssl","starttls"],"type":"string"},"username":{"description":"The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.","type":"string"}}},"gmail_v1_Thread":{"description":"A collection of messages representing a conversation.","type":"object","properties":{"historyId":{"description":"The ID of the last history record that modified this thread.","format":"uint64","type":"string"},"id":{"description":"The unique ID of the thread.","type":"string"},"messages":{"description":"The list of messages in the thread.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Message"}},"snippet":{"description":"A short part of the message text.","type":"string"}}},"gmail_v1_VacationSettings":{"description":"Vacation auto-reply settings for an account. These settings correspond to the \"Vacation responder\" feature in the web interface.","type":"object","properties":{"enableAutoReply":{"description":"Flag that controls whether Gmail automatically replies to messages.","type":"boolean"},"endTime":{"description":"An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.","format":"int64","type":"string"},"responseBodyHtml":{"description":"Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.","type":"string"},"responseBodyPlainText":{"description":"Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.","type":"string"},"responseSubject":{"description":"Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.","type":"string"},"restrictToContacts":{"description":"Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.","type":"boolean"},"restrictToDomain":{"description":"Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.","type":"boolean"},"startTime":{"description":"An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.","format":"int64","type":"string"}}},"gmail_v1_WatchRequest":{"description":"Set up or update a new push notification watch on this user's mailbox.","type":"object","properties":{"labelFilterAction":{"description":"Filtering behavior of `labelIds list` specified. This field is deprecated because it caused incorrect behavior in some cases; use `label_filter_behavior` instead.","enum":["include","exclude"],"type":"string"},"labelFilterBehavior":{"description":"Filtering behavior of `labelIds list` specified. This field replaces `label_filter_action`; if set, `label_filter_action` is ignored.","enum":["include","exclude"],"type":"string"},"labelIds":{"description":"List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.","type":"array","items":{"type":"string"}},"topicName":{"description":"A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail \"publish\" permission on it. For example, \"projects/my-project-identifier/topics/my-topic-name\" (using the Cloud Pub/Sub \"v1\" topic naming format). Note that the \"my-project-identifier\" portion must exactly match your Google developer project id (the one executing this watch request).","type":"string"}}},"gmail_v1_WatchResponse":{"description":"Push notification watch response.","type":"object","properties":{"expiration":{"description":"When Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch.","format":"int64","type":"string"},"historyId":{"description":"The ID of the mailbox's current history record.","format":"uint64","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://mail.google.com/":"","https://www.googleapis.com/auth/gmail.settings.basic":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/gmail/v1/rest","service":"gmail","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Gmail API","version":"v1","description":"The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels."},"servers":[{"url":"https://gmail.googleapis.com/"}],"paths":{"/gmail/v1/users/{userId}/drafts":{"get":{"operationId":"gmail.users.drafts.list","x-executor-toolPath":"gmail.users.drafts.list","tags":["Gmail API"],"description":"Lists the drafts in the user's mailbox. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeSpamTrash","in":"query","required":false,"description":"Include drafts from `SPAM` and `TRASH` in the results.","schema":{"description":"Include drafts from `SPAM` and `TRASH` in the results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","schema":{"description":"Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListDraftsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]},"post":{"operationId":"gmail.users.drafts.create","x-executor-toolPath":"gmail.users.drafts.create","tags":["Gmail API"],"description":"Creates a draft with the `DRAFT` label. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/drafts/send":{"post":{"operationId":"gmail.users.drafts.send","x-executor-toolPath":"gmail.users.drafts.send","tags":["Gmail API"],"description":"Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/drafts/{id}":{"get":{"operationId":"gmail.users.drafts.get","x-executor-toolPath":"gmail.users.drafts.get","tags":["Gmail API"],"description":"Gets the specified draft. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to retrieve.","schema":{"description":"The ID of the draft to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"format","in":"query","required":false,"description":"The format to return the draft in.","schema":{"description":"The format to return the draft in.","default":"full","enum":["minimal","full","raw","metadata"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]},"put":{"operationId":"gmail.users.drafts.update","x-executor-toolPath":"gmail.users.drafts.update","tags":["Gmail API"],"description":"Replaces a draft's content. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to update.","schema":{"description":"The ID of the draft to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]},"delete":{"operationId":"gmail.users.drafts.delete","x-executor-toolPath":"gmail.users.drafts.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified draft. Does not simply trash it. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to delete.","schema":{"description":"The ID of the draft to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/history":{"get":{"operationId":"gmail.users.history.list","x-executor-toolPath":"gmail.users.history.list","tags":["Gmail API"],"description":"Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`). For more information, see [Synchronize clients with Gmail](https://developers.google.com/workspace/gmail/api/guides/sync).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"historyTypes","in":"query","required":false,"description":"History types to be returned by the function","schema":{"type":"array","items":{"description":"History types to be returned by the function","enum":["messageAdded","messageDeleted","labelAdded","labelRemoved"],"type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"labelId","in":"query","required":false,"description":"Only return messages with a label matching the ID.","schema":{"description":"Only return messages with a label matching the ID.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"startHistoryId","in":"query","required":false,"description":"Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request.","schema":{"description":"Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an `HTTP 404` error response, your application should perform a full sync. If you receive no `nextPageToken` in the response, there are no updates to retrieve and you can store the returned `historyId` for a future request.","format":"uint64","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListHistoryResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/labels":{"get":{"operationId":"gmail.users.labels.list","x-executor-toolPath":"gmail.users.labels.list","tags":["Gmail API"],"description":"Lists all labels in the user's mailbox. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListLabelsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.labels"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]},"post":{"operationId":"gmail.users.labels.create","x-executor-toolPath":"gmail.users.labels.create","tags":["Gmail API"],"description":"Creates a label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.labels"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/labels/{id}":{"get":{"operationId":"gmail.users.labels.get","x-executor-toolPath":"gmail.users.labels.get","tags":["Gmail API"],"description":"Gets the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to retrieve.","schema":{"description":"The ID of the label to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.labels"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]},"put":{"operationId":"gmail.users.labels.update","x-executor-toolPath":"gmail.users.labels.update","tags":["Gmail API"],"description":"Updates the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to update.","schema":{"description":"The ID of the label to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.labels"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]},"delete":{"operationId":"gmail.users.labels.delete","x-executor-toolPath":"gmail.users.labels.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified label and removes it from any messages and threads that it's applied to. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to delete.","schema":{"description":"The ID of the label to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.labels"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]},"patch":{"operationId":"gmail.users.labels.patch","x-executor-toolPath":"gmail.users.labels.patch","tags":["Gmail API"],"description":"Patch the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the label to update.","schema":{"description":"The ID of the label to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Label"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.labels"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.labels","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages":{"get":{"operationId":"gmail.users.messages.list","x-executor-toolPath":"gmail.users.messages.list","tags":["Gmail API"],"description":"Lists the messages in the user's mailbox. For more information, see [List Gmail messages](https://developers.google.com/workspace/gmail/api/guides/list-messages).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeSpamTrash","in":"query","required":false,"description":"Include messages from `SPAM` and `TRASH` in the results.","schema":{"description":"Include messages from `SPAM` and `TRASH` in the results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"labelIds","in":"query","required":false,"description":"Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads).","schema":{"type":"array","items":{"description":"Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads).","type":"string"}},"style":"form","explode":true},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","schema":{"description":"Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListMessagesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]},"post":{"operationId":"gmail.users.messages.insert","x-executor-toolPath":"gmail.users.messages.insert","tags":["Gmail API"],"description":"Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"receivedTime","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.insert"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.insert","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/batchDelete":{"post":{"operationId":"gmail.users.messages.batchDelete","x-executor-toolPath":"gmail.users.messages.batchDelete","tags":["Gmail API"],"description":"Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_BatchDeleteMessagesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/batchModify":{"post":{"operationId":"gmail.users.messages.batchModify","x-executor-toolPath":"gmail.users.messages.batchModify","tags":["Gmail API"],"description":"Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_BatchModifyMessagesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/import":{"post":{"operationId":"gmail.users.messages.import","x-executor-toolPath":"gmail.users.messages.import","tags":["Gmail API"],"description":"Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note that the maximum size of the message is 150 MB.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"dateHeader","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"neverMarkSpam","in":"query","required":false,"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","schema":{"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"processForCalendar","in":"query","required":false,"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","schema":{"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.insert"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.insert","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/send":{"post":{"operationId":"gmail.users.messages.send","x-executor-toolPath":"gmail.users.messages.send","tags":["Gmail API"],"description":"Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.send"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.send","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}":{"get":{"operationId":"gmail.users.messages.get","x-executor-toolPath":"gmail.users.messages.get","tags":["Gmail API"],"description":"Gets the specified message.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).","schema":{"description":"The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"format","in":"query","required":false,"description":"The format to return the message in.","schema":{"description":"The format to return the message in.","default":"full","enum":["minimal","full","raw","metadata"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"metadataHeaders","in":"query","required":false,"description":"When given and format is `METADATA`, only include headers specified.","schema":{"type":"array","items":{"description":"When given and format is `METADATA`, only include headers specified.","type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]},"delete":{"operationId":"gmail.users.messages.delete","x-executor-toolPath":"gmail.users.messages.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to delete.","schema":{"description":"The ID of the message to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}/modify":{"post":{"operationId":"gmail.users.messages.modify","x-executor-toolPath":"gmail.users.messages.modify","tags":["Gmail API"],"description":"Modifies the labels and the Classification Label values on the specified message. For administrators modifying message for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to modify.","schema":{"description":"The ID of the message to modify.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ModifyMessageRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}/trash":{"post":{"operationId":"gmail.users.messages.trash","x-executor-toolPath":"gmail.users.messages.trash","tags":["Gmail API"],"description":"Moves the specified message to the trash.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to Trash.","schema":{"description":"The ID of the message to Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{id}/untrash":{"post":{"operationId":"gmail.users.messages.untrash","x-executor-toolPath":"gmail.users.messages.untrash","tags":["Gmail API"],"description":"Removes the specified message from the trash.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the message to remove from Trash.","schema":{"description":"The ID of the message to remove from Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}":{"get":{"operationId":"gmail.users.messages.attachments.get","x-executor-toolPath":"gmail.users.messages.attachments.get","tags":["Gmail API"],"description":"Gets the specified message attachment.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"messageId","in":"path","required":true,"description":"The ID of the message containing the attachment.","schema":{"description":"The ID of the message containing the attachment.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the attachment.","schema":{"description":"The ID of the attachment.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_MessagePartBody"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/profile":{"get":{"operationId":"gmail.users.getProfile","x-executor-toolPath":"gmail.users.getProfile","tags":["Gmail API"],"description":"Gets the current user's Gmail profile.","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Profile"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/settings/autoForwarding":{"get":{"operationId":"gmail.users.settings.getAutoForwarding","x-executor-toolPath":"gmail.users.settings.getAutoForwarding","tags":["Gmail API"],"description":"Gets the auto-forwarding setting for the specified account. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_AutoForwarding"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/identities":{"get":{"operationId":"gmail.users.settings.cse.identities.list","x-executor-toolPath":"gmail.users.settings.cse.identities.list","tags":["Gmail API"],"description":"Lists the client-side encrypted identities for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The number of identities to return. If not provided, the page size will default to 20 entries.","schema":{"description":"The number of identities to return. If not provided, the page size will default to 20 entries.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.","schema":{"description":"Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListCseIdentitiesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.cse.identities.create","x-executor-toolPath":"gmail.users.settings.cse.identities.create","tags":["Gmail API"],"description":"Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}":{"get":{"operationId":"gmail.users.settings.cse.identities.get","x-executor-toolPath":"gmail.users.settings.cse.identities.get","tags":["Gmail API"],"description":"Retrieves a client-side encryption identity configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"cseEmailAddress","in":"path","required":true,"description":"The primary email address associated with the client-side encryption identity configuration that's retrieved.","schema":{"description":"The primary email address associated with the client-side encryption identity configuration that's retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"delete":{"operationId":"gmail.users.settings.cse.identities.delete","x-executor-toolPath":"gmail.users.settings.cse.identities.delete","tags":["Gmail API"],"description":"Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"cseEmailAddress","in":"path","required":true,"description":"The primary email address associated with the client-side encryption identity configuration that's removed.","schema":{"description":"The primary email address associated with the client-side encryption identity configuration that's removed.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}":{"patch":{"operationId":"gmail.users.settings.cse.identities.patch","x-executor-toolPath":"gmail.users.settings.cse.identities.patch","tags":["Gmail API"],"description":"Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887). For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"emailAddress","in":"path","required":true,"description":"The email address of the client-side encryption identity to update.","schema":{"description":"The email address of the client-side encryption identity to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs":{"get":{"operationId":"gmail.users.settings.cse.keypairs.list","x-executor-toolPath":"gmail.users.settings.cse.keypairs.list","tags":["Gmail API"],"description":"Lists client-side encryption key pairs for an authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"The number of key pairs to return. If not provided, the page size will default to 20 entries.","schema":{"description":"The number of key pairs to return. If not provided, the page size will default to 20 entries.","format":"int32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.","schema":{"description":"Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListCseKeyPairsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.cse.keypairs.create","x-executor-toolPath":"gmail.users.settings.cse.keypairs.create","tags":["Gmail API"],"description":"Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"chainValidation","in":"query","required":false,"description":"The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation checks. When unspecified, this parameter defaults to `all`.","schema":{"description":"The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation checks. When unspecified, this parameter defaults to `all`.","default":"all","enum":["all","none"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}":{"get":{"operationId":"gmail.users.settings.cse.keypairs.get","x-executor-toolPath":"gmail.users.settings.cse.keypairs.get","tags":["Gmail API"],"description":"Retrieves an existing client-side encryption key pair. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to retrieve.","schema":{"description":"The identifier of the key pair to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable":{"post":{"operationId":"gmail.users.settings.cse.keypairs.disable","x-executor-toolPath":"gmail.users.settings.cse.keypairs.disable","tags":["Gmail API"],"description":"Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to turn off.","schema":{"description":"The identifier of the key pair to turn off.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_DisableCseKeyPairRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable":{"post":{"operationId":"gmail.users.settings.cse.keypairs.enable","x-executor-toolPath":"gmail.users.settings.cse.keypairs.enable","tags":["Gmail API"],"description":"Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to turn on.","schema":{"description":"The identifier of the key pair to turn on.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_EnableCseKeyPairRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate":{"post":{"operationId":"gmail.users.settings.cse.keypairs.obliterate","x-executor-toolPath":"gmail.users.settings.cse.keypairs.obliterate","tags":["Gmail API"],"description":"Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","parameters":[{"name":"userId","in":"path","required":true,"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","schema":{"description":"The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.","default":"me","type":"string"}},{"name":"keyPairId","in":"path","required":true,"description":"The identifier of the key pair to obliterate.","schema":{"description":"The identifier of the key pair to obliterate.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ObliterateCseKeyPairRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/filters":{"get":{"operationId":"gmail.users.settings.filters.list","x-executor-toolPath":"gmail.users.settings.filters.list","tags":["Gmail API"],"description":"Lists the message filters of a Gmail user. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListFiltersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.filters.create","x-executor-toolPath":"gmail.users.settings.filters.create","tags":["Gmail API"],"description":"Creates a filter. Note: you can only create a maximum of 1,000 filters. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/filters/{id}":{"get":{"operationId":"gmail.users.settings.filters.get","x-executor-toolPath":"gmail.users.settings.filters.get","tags":["Gmail API"],"description":"Gets a filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the filter to be fetched.","schema":{"description":"The ID of the filter to be fetched.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"delete":{"operationId":"gmail.users.settings.filters.delete","x-executor-toolPath":"gmail.users.settings.filters.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the filter to be deleted.","schema":{"description":"The ID of the filter to be deleted.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/forwardingAddresses":{"get":{"operationId":"gmail.users.settings.forwardingAddresses.list","x-executor-toolPath":"gmail.users.settings.forwardingAddresses.list","tags":["Gmail API"],"description":"Lists the forwarding addresses for the specified account. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListForwardingAddressesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}":{"get":{"operationId":"gmail.users.settings.forwardingAddresses.get","x-executor-toolPath":"gmail.users.settings.forwardingAddresses.get","tags":["Gmail API"],"description":"Gets the specified forwarding address. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"forwardingEmail","in":"path","required":true,"description":"The forwarding address to be retrieved.","schema":{"description":"The forwarding address to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ForwardingAddress"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/imap":{"get":{"operationId":"gmail.users.settings.getImap","x-executor-toolPath":"gmail.users.settings.getImap","tags":["Gmail API"],"description":"Gets IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ImapSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updateImap","x-executor-toolPath":"gmail.users.settings.updateImap","tags":["Gmail API"],"description":"Updates IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ImapSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ImapSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/language":{"get":{"operationId":"gmail.users.settings.getLanguage","x-executor-toolPath":"gmail.users.settings.getLanguage","tags":["Gmail API"],"description":"Gets language settings. For more information, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_LanguageSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updateLanguage","x-executor-toolPath":"gmail.users.settings.updateLanguage","tags":["Gmail API"],"description":"Updates language settings. For more information, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_LanguageSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_LanguageSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/pop":{"get":{"operationId":"gmail.users.settings.getPop","x-executor-toolPath":"gmail.users.settings.getPop","tags":["Gmail API"],"description":"Gets POP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_PopSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updatePop","x-executor-toolPath":"gmail.users.settings.updatePop","tags":["Gmail API"],"description":"Updates POP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_PopSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_PopSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs":{"get":{"operationId":"gmail.users.settings.sendAs.list","x-executor-toolPath":"gmail.users.settings.sendAs.list","tags":["Gmail API"],"description":"Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom \"from\" aliases. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListSendAsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}":{"get":{"operationId":"gmail.users.settings.sendAs.get","x-executor-toolPath":"gmail.users.settings.sendAs.get","tags":["Gmail API"],"description":"Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The send-as alias to be retrieved.","schema":{"description":"The send-as alias to be retrieved.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.sendAs.update","x-executor-toolPath":"gmail.users.settings.sendAs.update","tags":["Gmail API"],"description":"Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings). Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The send-as alias to be updated.","schema":{"description":"The send-as alias to be updated.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]},"patch":{"operationId":"gmail.users.settings.sendAs.patch","x-executor-toolPath":"gmail.users.settings.sendAs.patch","tags":["Gmail API"],"description":"Patch the specified send-as alias. For more information, see [Manage aliases and signatures with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/alias_and_signature_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The send-as alias to be updated.","schema":{"description":"The send-as alias to be updated.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo":{"get":{"operationId":"gmail.users.settings.sendAs.smimeInfo.list","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.list","tags":["Gmail API"],"description":"Lists S/MIME configs for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListSmimeInfoResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"post":{"operationId":"gmail.users.settings.sendAs.smimeInfo.insert","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.insert","tags":["Gmail API"],"description":"Insert (upload) the given S/MIME config for the specified send-as alias. Note that `pkcs12` format is required for the key. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}":{"get":{"operationId":"gmail.users.settings.sendAs.smimeInfo.get","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.get","tags":["Gmail API"],"description":"Gets the specified S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The immutable ID for the SmimeInfo.","schema":{"description":"The immutable ID for the SmimeInfo.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"delete":{"operationId":"gmail.users.settings.sendAs.smimeInfo.delete","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.delete","tags":["Gmail API"],"description":"Deletes the specified S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The immutable ID for the SmimeInfo.","schema":{"description":"The immutable ID for the SmimeInfo.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault":{"post":{"operationId":"gmail.users.settings.sendAs.smimeInfo.setDefault","x-executor-toolPath":"gmail.users.settings.sendAs.smimeInfo.setDefault","tags":["Gmail API"],"description":"Sets the default S/MIME config for the specified send-as alias. For more information, see [Manage S/MIME certificates with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/smime_certs).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"sendAsEmail","in":"path","required":true,"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","schema":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias.","type":"string"}},{"name":"id","in":"path","required":true,"description":"The immutable ID for the SmimeInfo.","schema":{"description":"The immutable ID for the SmimeInfo.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/settings/vacation":{"get":{"operationId":"gmail.users.settings.getVacation","x-executor-toolPath":"gmail.users.settings.getVacation","tags":["Gmail API"],"description":"Gets vacation responder settings. For more information, see [Manage vacation settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/vacation_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_VacationSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]},"put":{"operationId":"gmail.users.settings.updateVacation","x-executor-toolPath":"gmail.users.settings.updateVacation","tags":["Gmail API"],"description":"Updates vacation responder settings. For more information, see [Manage vacation settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/vacation_settings).","parameters":[{"name":"userId","in":"path","required":true,"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","schema":{"description":"User's email address. The special value \"me\" can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_VacationSettings"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_VacationSettings"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.settings.basic"]}},"/gmail/v1/users/{userId}/stop":{"post":{"operationId":"gmail.users.stop","x-executor-toolPath":"gmail.users.stop","tags":["Gmail API"],"description":"Turn off push notification delivery for the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads":{"get":{"operationId":"gmail.users.threads.list","x-executor-toolPath":"gmail.users.threads.list","tags":["Gmail API"],"description":"Lists the threads in the user's mailbox. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeSpamTrash","in":"query","required":false,"description":"Include threads from `SPAM` and `TRASH` in the results.","schema":{"description":"Include threads from `SPAM` and `TRASH` in the results.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"labelIds","in":"query","required":false,"description":"Only return threads with labels that match all of the specified label IDs.","schema":{"type":"array","items":{"description":"Only return threads with labels that match all of the specified label IDs.","type":"string"}},"style":"form","explode":true},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.","schema":{"description":"Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.","format":"uint32","default":100,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token to retrieve a specific page of results in the list.","schema":{"description":"Page token to retrieve a specific page of results in the list.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","schema":{"description":"Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ListThreadsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}":{"get":{"operationId":"gmail.users.threads.get","x-executor-toolPath":"gmail.users.threads.get","tags":["Gmail API"],"description":"Gets the specified thread. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to retrieve.","schema":{"description":"The ID of the thread to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"format","in":"query","required":false,"description":"The format to return the messages in.","schema":{"description":"The format to return the messages in.","default":"full","enum":["full","metadata","minimal"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"metadataHeaders","in":"query","required":false,"description":"When given and format is METADATA, only include headers specified.","schema":{"type":"array","items":{"description":"When given and format is METADATA, only include headers specified.","type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]},"delete":{"operationId":"gmail.users.threads.delete","x-executor-toolPath":"gmail.users.threads.delete","tags":["Gmail API"],"description":"Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer `threads.trash` instead. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"ID of the Thread to delete.","schema":{"description":"ID of the Thread to delete.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}/modify":{"post":{"operationId":"gmail.users.threads.modify","x-executor-toolPath":"gmail.users.threads.modify","tags":["Gmail API"],"description":"Modifies the labels applied to the thread. This applies to all messages in the thread. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to modify.","schema":{"description":"The ID of the thread to modify.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_ModifyThreadRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}/trash":{"post":{"operationId":"gmail.users.threads.trash","x-executor-toolPath":"gmail.users.threads.trash","tags":["Gmail API"],"description":"Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to Trash.","schema":{"description":"The ID of the thread to Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/threads/{id}/untrash":{"post":{"operationId":"gmail.users.threads.untrash","x-executor-toolPath":"gmail.users.threads.untrash","tags":["Gmail API"],"description":"Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash. For more information, see [Manage threads](https://developers.google.com/workspace/gmail/api/guides/threads).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the thread to remove from Trash.","schema":{"description":"The ID of the thread to remove from Trash.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/gmail/v1/users/{userId}/watch":{"post":{"operationId":"gmail.users.watch","x-executor-toolPath":"gmail.users.watch","tags":["Gmail API"],"description":"Set up or update a push notification watch on the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_WatchRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_WatchResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.metadata"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.readonly"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.metadata","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.readonly","https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/drafts":{"post":{"operationId":"gmail.users.drafts.createMedia","x-executor-toolPath":"gmail.users.drafts.createMedia","tags":["Gmail API"],"description":"Creates a draft with the `DRAFT` label. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/drafts/send":{"post":{"operationId":"gmail.users.drafts.sendMedia","x-executor-toolPath":"gmail.users.drafts.sendMedia","tags":["Gmail API"],"description":"Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/drafts/{id}":{"put":{"operationId":"gmail.users.drafts.updateMedia","x-executor-toolPath":"gmail.users.drafts.updateMedia","tags":["Gmail API"],"description":"Replaces a draft's content. For more information, see [Create and send draft emails](https://developers.google.com/workspace/gmail/api/guides/drafts). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"id","in":"path","required":true,"description":"The ID of the draft to update.","schema":{"description":"The ID of the draft to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Draft"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/messages":{"post":{"operationId":"gmail.users.messages.insertMedia","x-executor-toolPath":"gmail.users.messages.insertMedia","tags":["Gmail API"],"description":"Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"receivedTime","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.insert"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.insert","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/messages/import":{"post":{"operationId":"gmail.users.messages.importMedia","x-executor-toolPath":"gmail.users.messages.importMedia","tags":["Gmail API"],"description":"Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Note that the maximum size of the message is 150 MB. (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleted","in":"query","required":false,"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","schema":{"description":"Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"internalDateSource","in":"query","required":false,"description":"Source for Gmail's internal date of the message.","schema":{"description":"Source for Gmail's internal date of the message.","default":"dateHeader","enum":["receivedTime","dateHeader"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"neverMarkSpam","in":"query","required":false,"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","schema":{"description":"Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"processForCalendar","in":"query","required":false,"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","schema":{"description":"Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.insert"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.insert","https://www.googleapis.com/auth/gmail.modify","https://mail.google.com/"]}},"/upload/gmail/v1/users/{userId}/messages/send":{"post":{"operationId":"gmail.users.messages.sendMedia","x-executor-toolPath":"gmail.users.messages.sendMedia","tags":["Gmail API"],"description":"Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For more information, see [Create and send email messages](https://developers.google.com/workspace/gmail/api/guides/sending). (media upload)","parameters":[{"name":"userId","in":"path","required":true,"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","schema":{"description":"The user's email address. The special value `me` can be used to indicate the authenticated user.","default":"me","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gmail_v1_Message"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/gmail.compose"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.modify"]},{"googleOAuth2":["https://www.googleapis.com/auth/gmail.send"]},{"googleOAuth2":["https://mail.google.com/"]}],"x-google-scopes":["https://www.googleapis.com/auth/gmail.compose","https://www.googleapis.com/auth/gmail.modify","https://www.googleapis.com/auth/gmail.send","https://mail.google.com/"]}}},"components":{"schemas":{"gmail_v1_AutoForwarding":{"description":"Auto-forwarding settings for an account.","type":"object","properties":{"disposition":{"description":"The state that a message should be left in after it has been forwarded.","enum":["dispositionUnspecified","leaveInInbox","archive","trash","markRead"],"type":"string"},"emailAddress":{"description":"Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.","type":"string"},"enabled":{"description":"Whether all incoming mail is automatically forwarded to another address.","type":"boolean"}}},"gmail_v1_BatchDeleteMessagesRequest":{"type":"object","properties":{"ids":{"description":"The IDs of the messages to delete.","type":"array","items":{"type":"string"}}}},"gmail_v1_BatchModifyMessagesRequest":{"type":"object","properties":{"addClassificationLabels":{"description":"A list of Classification Label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelValue"}},"addLabelIds":{"description":"A list of label IDs to add to messages.","type":"array","items":{"type":"string"}},"ids":{"description":"The IDs of the messages to modify. There is a limit of 1000 ids per request.","type":"array","items":{"type":"string"}},"removeClassificationLabelIds":{"description":"A list of Classification Label values to remove from messages.","type":"array","items":{"type":"string"}},"removeLabelIds":{"description":"A list of label IDs to remove from messages.","type":"array","items":{"type":"string"}}}},"gmail_v1_ClassificationLabelFieldValue":{"description":"Field values for a classification label.","type":"object","properties":{"fieldId":{"description":"Required. The field ID for the Classification Label Value. Maps to the ID field of the Google Drive `Label.Field` object.","type":"string"},"selection":{"description":"Selection choice ID for the selection option. Should only be set if the field type is `SELECTION` in the Google Drive `Label.Field` object. Maps to the id field of the Google Drive `Label.Field.SelectionOptions` resource.","type":"string"}}},"gmail_v1_ClassificationLabelValue":{"description":"Classification Labels applied to the email message. Classification Labels are different from Gmail inbox labels. Only used for Google Workspace accounts. [Learn more about classification labels](https://support.google.com/a/answer/9292382).","type":"object","properties":{"fields":{"description":"Field values for the given classification label ID.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelFieldValue"}},"labelId":{"description":"Required. The canonical or raw alphanumeric classification label ID. Maps to the ID field of the Google Drive Label resource.","type":"string"}}},"gmail_v1_CseIdentity":{"description":"The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","type":"object","properties":{"emailAddress":{"description":"The email address for the sending identity. The email address must be the primary email address of the authenticated user.","type":"string"},"primaryKeyPairId":{"description":"If a key pair is associated, the ID of the key pair, CseKeyPair.","type":"string"},"signAndEncryptKeyPairs":{"$ref":"#/components/schemas/gmail_v1_SignAndEncryptKeyPairs"}}},"gmail_v1_CseKeyPair":{"description":"A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.","type":"object","properties":{"disableTime":{"description":"Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.","format":"google-datetime","readOnly":true,"type":"string"},"enablementState":{"description":"Output only. The current state of the key pair.","readOnly":true,"enum":["stateUnspecified","enabled","disabled"],"type":"string"},"keyPairId":{"description":"Output only. The immutable ID for the client-side encryption S/MIME key pair.","readOnly":true,"type":"string"},"pem":{"description":"Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.","readOnly":true,"type":"string"},"pkcs7":{"description":"Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.","type":"string"},"privateKeyMetadata":{"description":"Metadata for instances of this key pair's private key.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_CsePrivateKeyMetadata"}},"subjectEmailAddresses":{"description":"Output only. The email address identities that are specified on the leaf certificate.","readOnly":true,"type":"array","items":{"type":"string"}}}},"gmail_v1_CsePrivateKeyMetadata":{"description":"Metadata for a private key instance.","type":"object","properties":{"hardwareKeyMetadata":{"$ref":"#/components/schemas/gmail_v1_HardwareKeyMetadata"},"kaclsKeyMetadata":{"$ref":"#/components/schemas/gmail_v1_KaclsKeyMetadata"},"privateKeyMetadataId":{"description":"Output only. The immutable ID for the private key metadata instance.","readOnly":true,"type":"string"}}},"gmail_v1_Delegate":{"description":"Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See \"Set up mail delegation\" for more information about delegates.","type":"object","properties":{"delegateEmail":{"description":"The email address of the delegate.","type":"string"},"verificationStatus":{"description":"Indicates whether this address has been verified and can act as a delegate for the account. Read-only.","enum":["verificationStatusUnspecified","accepted","pending","rejected","expired"],"type":"string"}}},"gmail_v1_DisableCseKeyPairRequest":{"description":"Requests to turn off a client-side encryption key pair.","type":"object"},"gmail_v1_Draft":{"description":"A draft email in the user's mailbox.","type":"object","properties":{"id":{"description":"The immutable ID of the draft.","type":"string"},"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_EnableCseKeyPairRequest":{"description":"Requests to turn on a client-side encryption key pair.","type":"object"},"gmail_v1_Filter":{"description":"Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.","type":"object","properties":{"action":{"$ref":"#/components/schemas/gmail_v1_FilterAction"},"criteria":{"$ref":"#/components/schemas/gmail_v1_FilterCriteria"},"id":{"description":"The server assigned ID of the filter.","type":"string"}}},"gmail_v1_FilterAction":{"description":"A set of actions to perform on a message.","type":"object","properties":{"addLabelIds":{"description":"List of labels to add to the message.","type":"array","items":{"type":"string"}},"forward":{"description":"Email address that the message should be forwarded to. This effectively redirects the message to the address specified in this field, maintaining the original sender in the \"From\" field.","type":"string"},"removeLabelIds":{"description":"List of labels to remove from the message.","type":"array","items":{"type":"string"}}}},"gmail_v1_FilterCriteria":{"description":"Message matching criteria.","type":"object","properties":{"excludeChats":{"description":"Whether the response should exclude chats.","type":"boolean"},"from":{"description":"The sender's display name or email address.","type":"string"},"hasAttachment":{"description":"Whether the message has any attachment.","type":"boolean"},"negatedQuery":{"description":"Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","type":"string"},"query":{"description":"Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `\"from:someuser@example.com rfc822msgid: is:unread\"`.","type":"string"},"size":{"description":"The size of the entire RFC822 message in bytes, including all headers and attachments.","format":"int32","type":"integer"},"sizeComparison":{"description":"How the message size in bytes should be in relation to the size field.","enum":["unspecified","smaller","larger"],"type":"string"},"subject":{"description":"Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.","type":"string"},"to":{"description":"The recipient's display name or email address. Includes recipients in the \"to\", \"cc\", and \"bcc\" header fields. You can use simply the local part of the email address. For example, \"example\" and \"example@\" both match \"example@gmail.com\". This field is case-insensitive.","type":"string"}}},"gmail_v1_ForwardingAddress":{"description":"Settings for a forwarding address.","type":"object","properties":{"forwardingEmail":{"description":"An email address to which messages can be forwarded.","type":"string"},"verificationStatus":{"description":"Indicates whether this address has been verified and is usable for forwarding. Read-only.","enum":["verificationStatusUnspecified","accepted","pending"],"type":"string"}}},"gmail_v1_HardwareKeyMetadata":{"description":"Metadata for hardware keys. If [hardware key encryption](https://support.google.com/a/answer/14153163) is set up for the Google Workspace organization, users can optionally store their private key on their smart card and use it to sign and decrypt email messages in Gmail by inserting their smart card into a reader attached to their Windows device.","type":"object","properties":{"description":{"description":"Description about the hardware key.","type":"string"}}},"gmail_v1_History":{"description":"A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.","type":"object","properties":{"id":{"description":"The mailbox sequence ID.","format":"uint64","type":"string"},"labelsAdded":{"description":"Labels added to messages in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryLabelAdded"}},"labelsRemoved":{"description":"Labels removed from messages in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryLabelRemoved"}},"messages":{"description":"List of messages changed in this history record. The fields for specific change types, such as `messagesAdded` may duplicate messages in this field. We recommend using the specific change-type fields instead of this.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Message"}},"messagesAdded":{"description":"Messages added to the mailbox in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryMessageAdded"}},"messagesDeleted":{"description":"Messages deleted (not Trashed) from the mailbox in this history record.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_HistoryMessageDeleted"}}}},"gmail_v1_HistoryLabelAdded":{"type":"object","properties":{"labelIds":{"description":"Label IDs added to the message.","type":"array","items":{"type":"string"}},"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_HistoryLabelRemoved":{"type":"object","properties":{"labelIds":{"description":"Label IDs removed from the message.","type":"array","items":{"type":"string"}},"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_HistoryMessageAdded":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_HistoryMessageDeleted":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/gmail_v1_Message"}}},"gmail_v1_ImapSettings":{"description":"IMAP settings for an account.","type":"object","properties":{"autoExpunge":{"description":"If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.","type":"boolean"},"enabled":{"description":"Whether IMAP is enabled for the account.","type":"boolean"},"expungeBehavior":{"description":"The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.","enum":["expungeBehaviorUnspecified","archive","trash","deleteForever"],"type":"string"},"maxFolderSize":{"description":"An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.","format":"int32","type":"integer"}}},"gmail_v1_KaclsKeyMetadata":{"description":"Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference).","type":"object","properties":{"kaclsData":{"description":"Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.","type":"string"},"kaclsUri":{"description":"The URI of the key access control list service that manages the private key.","type":"string"}}},"gmail_v1_Label":{"description":"Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000.","type":"object","properties":{"color":{"$ref":"#/components/schemas/gmail_v1_LabelColor"},"id":{"description":"The immutable ID of the label.","type":"string"},"labelListVisibility":{"description":"The visibility of the label in the label list in the Gmail web interface.","enum":["labelShow","labelShowIfUnread","labelHide"],"type":"string"},"messageListVisibility":{"description":"The visibility of messages with this label in the message list in the Gmail web interface.","enum":["show","hide"],"type":"string"},"messagesTotal":{"description":"The total number of messages with the label.","format":"int32","type":"integer"},"messagesUnread":{"description":"The number of unread messages with the label.","format":"int32","type":"integer"},"name":{"description":"The display name of the label.","type":"string"},"threadsTotal":{"description":"The total number of threads with the label.","format":"int32","type":"integer"},"threadsUnread":{"description":"The number of unread threads with the label.","format":"int32","type":"integer"},"type":{"description":"The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the `INBOX` and `UNREAD` labels from messages and threads, but cannot apply or remove the `DRAFTS` or `SENT` labels from messages or threads.","enum":["system","user"],"type":"string"}}},"gmail_v1_LabelColor":{"type":"object","properties":{"backgroundColor":{"description":"The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \\#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \\#083018","type":"string"},"textColor":{"description":"The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \\#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \\#083018","type":"string"}}},"gmail_v1_LanguageSettings":{"description":"Language settings for an account. These settings correspond to the \"Language settings\" feature in the web interface.","type":"object","properties":{"displayLanguage":{"description":"The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the \"Language\" dropdown in the Gmail settings for all available options, as described in the language settings help article. For a table of sample values, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).","type":"string"}}},"gmail_v1_ListCseIdentitiesResponse":{"type":"object","properties":{"cseIdentities":{"description":"One page of the list of CSE identities configured for the user.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_CseIdentity"}},"nextPageToken":{"description":"Pagination token to be passed to a subsequent ListCseIdentities call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain.","type":"string"}}},"gmail_v1_ListCseKeyPairsResponse":{"type":"object","properties":{"cseKeyPairs":{"description":"One page of the list of CSE key pairs installed for the user.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_CseKeyPair"}},"nextPageToken":{"description":"Pagination token to be passed to a subsequent ListCseKeyPairs call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.","type":"string"}}},"gmail_v1_ListDelegatesResponse":{"description":"Response for the ListDelegates method.","type":"object","properties":{"delegates":{"description":"List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Delegate"}}}},"gmail_v1_ListDraftsResponse":{"type":"object","properties":{"drafts":{"description":"List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The [`messages.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/messages/get) method can fetch additional message details.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Draft"}},"nextPageToken":{"description":"Token to retrieve the next page of results in the list.","type":"string"},"resultSizeEstimate":{"description":"Estimated total number of results.","format":"uint32","type":"integer"}}},"gmail_v1_ListFiltersResponse":{"description":"Response for the ListFilters method.","type":"object","properties":{"filter":{"description":"List of a user's filters.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Filter"}}}},"gmail_v1_ListForwardingAddressesResponse":{"description":"Response for the ListForwardingAddresses method.","type":"object","properties":{"forwardingAddresses":{"description":"List of addresses that may be used for forwarding.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ForwardingAddress"}}}},"gmail_v1_ListHistoryResponse":{"type":"object","properties":{"history":{"description":"List of history records. Any `messages` contained in the response will typically only have `id` and `threadId` fields populated.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_History"}},"historyId":{"description":"The ID of the mailbox's current history record.","format":"uint64","type":"string"},"nextPageToken":{"description":"Page token to retrieve the next page of results in the list.","type":"string"}}},"gmail_v1_ListLabelsResponse":{"type":"object","properties":{"labels":{"description":"List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`labels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/labels/get) method can fetch additional label details.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Label"}}}},"gmail_v1_ListMessagesResponse":{"type":"object","properties":{"messages":{"description":"List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Message"}},"nextPageToken":{"description":"Token to retrieve the next page of results in the list.","type":"string"},"resultSizeEstimate":{"description":"Estimated total number of results.","format":"uint32","type":"integer"}}},"gmail_v1_ListSendAsResponse":{"description":"Response for the ListSendAs method.","type":"object","properties":{"sendAs":{"description":"List of send-as aliases.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_SendAs"}}}},"gmail_v1_ListSmimeInfoResponse":{"type":"object","properties":{"smimeInfo":{"description":"List of SmimeInfo.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_SmimeInfo"}}}},"gmail_v1_ListThreadsResponse":{"type":"object","properties":{"nextPageToken":{"description":"Page token to retrieve the next page of results in the list.","type":"string"},"resultSizeEstimate":{"description":"Estimated total number of results.","format":"uint32","type":"integer"},"threads":{"description":"List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the [`threads.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/threads/get) method.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Thread"}}}},"gmail_v1_Message":{"description":"An email message.","type":"object","properties":{"classificationLabelValues":{"description":"Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts. There's a limit of 20 Classification Label values per request. If the Classification Label values exceeds the maximum allowed number, the request fails.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelValue"}},"historyId":{"description":"The ID of the last history record that modified this message.","format":"uint64","type":"string"},"id":{"description":"The immutable ID of the message.","type":"string"},"internalDate":{"description":"The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.","format":"int64","type":"string"},"labelIds":{"description":"List of IDs of labels applied to this message.","type":"array","items":{"type":"string"}},"payload":{"$ref":"#/components/schemas/gmail_v1_MessagePart"},"raw":{"description":"The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update","format":"byte","type":"string"},"sizeEstimate":{"description":"Estimated size in bytes of the message.","format":"int32","type":"integer"},"snippet":{"description":"A short part of the message text.","type":"string"},"threadId":{"description":"The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. ","type":"string"}}},"gmail_v1_MessagePart":{"description":"A single MIME message part.","type":"object","properties":{"body":{"$ref":"#/components/schemas/gmail_v1_MessagePartBody"},"filename":{"description":"The filename of the attachment. Only present if this message part represents an attachment.","type":"string"},"headers":{"description":"List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_MessagePartHeader"}},"mimeType":{"description":"The MIME type of the message part.","type":"string"},"partId":{"description":"The immutable ID of the message part.","type":"string"},"parts":{"description":"The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_MessagePart"}}}},"gmail_v1_MessagePartBody":{"description":"The body of a single MIME message part.","type":"object","properties":{"attachmentId":{"description":"When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.","type":"string"},"data":{"description":"The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.","format":"byte","type":"string"},"size":{"description":"Number of bytes for the message part data (encoding notwithstanding).","format":"int32","type":"integer"}}},"gmail_v1_MessagePartHeader":{"type":"object","properties":{"name":{"description":"The name of the header before the `:` separator. For example, `To`.","type":"string"},"value":{"description":"The value of the header after the `:` separator. For example, `someuser@example.com`.","type":"string"}}},"gmail_v1_ModifyMessageRequest":{"type":"object","properties":{"addClassificationLabels":{"description":"A list of classification label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_ClassificationLabelValue"}},"addLabelIds":{"description":"A list of IDs of labels to add to this message. You can add up to 100 labels with each update.","type":"array","items":{"type":"string"}},"removeClassificationLabelIds":{"description":"A list of Classification Label values to remove from this message.","type":"array","items":{"type":"string"}},"removeLabelIds":{"description":"A list IDs of labels to remove from this message. You can remove up to 100 labels with each update.","type":"array","items":{"type":"string"}}}},"gmail_v1_ModifyThreadRequest":{"type":"object","properties":{"addLabelIds":{"description":"A list of IDs of labels to add to this thread. You can add up to 100 labels with each update.","type":"array","items":{"type":"string"}},"removeLabelIds":{"description":"A list of IDs of labels to remove from this thread. You can remove up to 100 labels with each update.","type":"array","items":{"type":"string"}}}},"gmail_v1_ObliterateCseKeyPairRequest":{"description":"Request to obliterate a CSE key pair.","type":"object"},"gmail_v1_PopSettings":{"description":"POP settings for an account.","type":"object","properties":{"accessWindow":{"description":"The range of messages which are accessible via POP.","enum":["accessWindowUnspecified","disabled","fromNowOn","allMail"],"type":"string"},"disposition":{"description":"The action that will be executed on a message after it has been fetched via POP.","enum":["dispositionUnspecified","leaveInInbox","archive","trash","markRead"],"type":"string"}}},"gmail_v1_Profile":{"description":"Profile for a Gmail user.","type":"object","properties":{"emailAddress":{"description":"The user's email address.","type":"string"},"historyId":{"description":"The ID of the mailbox's current history record.","format":"uint64","type":"string"},"messagesTotal":{"description":"The total number of messages in the mailbox.","format":"int32","type":"integer"},"threadsTotal":{"description":"The total number of threads in the mailbox.","format":"int32","type":"integer"}}},"gmail_v1_SendAs":{"description":"Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom \"from\" address. Send-as aliases correspond to the \"Send Mail As\" feature in the web interface. The send-as alias must be a valid email address.","type":"object","properties":{"displayName":{"description":"A name that appears in the \"From:\" header for mail sent using this alias. For custom \"from\" addresses, when this is empty, Gmail will populate the \"From:\" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.","type":"string"},"isDefault":{"description":"Whether this address is selected as the default \"From:\" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.","type":"boolean"},"isPrimary":{"description":"Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.","type":"boolean"},"replyToAddress":{"description":"An optional email address that is included in a \"Reply-To:\" header for mail sent using this alias. If this is empty, Gmail will not generate a \"Reply-To:\" header.","type":"string"},"sendAsEmail":{"description":"The email address that appears in the \"From:\" header for mail sent using this alias. This is read-only for all operations except create.","type":"string"},"signature":{"description":"An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.","type":"string"},"smtpMsa":{"$ref":"#/components/schemas/gmail_v1_SmtpMsa"},"treatAsAlias":{"description":"Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom \"from\" aliases.","type":"boolean"},"verificationStatus":{"description":"Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom \"from\" aliases.","enum":["verificationStatusUnspecified","accepted","pending"],"type":"string"}}},"gmail_v1_SignAndEncryptKeyPairs":{"description":"The configuration of a CSE identity that uses different key pairs for signing and encryption.","type":"object","properties":{"encryptionKeyPairId":{"description":"The ID of the CseKeyPair that encrypts signed outgoing mail.","type":"string"},"signingKeyPairId":{"description":"The ID of the CseKeyPair that signs outgoing mail.","type":"string"}}},"gmail_v1_SmimeInfo":{"description":"An S/MIME email config.","type":"object","properties":{"encryptedKeyPassword":{"description":"Encrypted key password, when key is encrypted.","type":"string"},"expiration":{"description":"When the certificate expires (in milliseconds since epoch).","format":"int64","type":"string"},"id":{"description":"The immutable ID for the SmimeInfo.","type":"string"},"isDefault":{"description":"Whether this SmimeInfo is the default one for this user's send-as address.","type":"boolean"},"issuerCn":{"description":"The S/MIME certificate issuer's common name.","type":"string"},"pem":{"description":"PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).","type":"string"},"pkcs12":{"description":"PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.","format":"byte","type":"string"}}},"gmail_v1_SmtpMsa":{"description":"Configuration for communication with an SMTP service.","type":"object","properties":{"host":{"description":"The hostname of the SMTP service. Required.","type":"string"},"password":{"description":"The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.","type":"string"},"port":{"description":"The port of the SMTP service. Required.","format":"int32","type":"integer"},"securityMode":{"description":"The protocol that will be used to secure communication with the SMTP service. Required.","enum":["securityModeUnspecified","none","ssl","starttls"],"type":"string"},"username":{"description":"The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.","type":"string"}}},"gmail_v1_Thread":{"description":"A collection of messages representing a conversation.","type":"object","properties":{"historyId":{"description":"The ID of the last history record that modified this thread.","format":"uint64","type":"string"},"id":{"description":"The unique ID of the thread.","type":"string"},"messages":{"description":"The list of messages in the thread.","type":"array","items":{"$ref":"#/components/schemas/gmail_v1_Message"}},"snippet":{"description":"A short part of the message text.","type":"string"}}},"gmail_v1_VacationSettings":{"description":"Vacation auto-reply settings for an account. These settings correspond to the \"Vacation responder\" feature in the web interface.","type":"object","properties":{"enableAutoReply":{"description":"Flag that controls whether Gmail automatically replies to messages.","type":"boolean"},"endTime":{"description":"An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.","format":"int64","type":"string"},"responseBodyHtml":{"description":"Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.","type":"string"},"responseBodyPlainText":{"description":"Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.","type":"string"},"responseSubject":{"description":"Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.","type":"string"},"restrictToContacts":{"description":"Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.","type":"boolean"},"restrictToDomain":{"description":"Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.","type":"boolean"},"startTime":{"description":"An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.","format":"int64","type":"string"}}},"gmail_v1_WatchRequest":{"description":"Set up or update a new push notification watch on this user's mailbox.","type":"object","properties":{"labelFilterAction":{"description":"Filtering behavior of `labelIds list` specified. This field is deprecated because it caused incorrect behavior in some cases; use `label_filter_behavior` instead.","enum":["include","exclude"],"type":"string"},"labelFilterBehavior":{"description":"Filtering behavior of `labelIds list` specified. This field replaces `label_filter_action`; if set, `label_filter_action` is ignored.","enum":["include","exclude"],"type":"string"},"labelIds":{"description":"List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.","type":"array","items":{"type":"string"}},"topicName":{"description":"A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail \"publish\" permission on it. For example, \"projects/my-project-identifier/topics/my-topic-name\" (using the Cloud Pub/Sub \"v1\" topic naming format). Note that the \"my-project-identifier\" portion must exactly match your Google developer project id (the one executing this watch request).","type":"string"}}},"gmail_v1_WatchResponse":{"description":"Push notification watch response.","type":"object","properties":{"expiration":{"description":"When Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch.","format":"int64","type":"string"},"historyId":{"description":"The ID of the mailbox's current history record.","format":"uint64","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://mail.google.com/":"Read, compose, send, and permanently delete all your email from Gmail","https://www.googleapis.com/auth/gmail.settings.basic":"See, edit, create, or change your email settings and filters in Gmail","https://www.googleapis.com/auth/gmail.metadata":"View your email message metadata such as labels and headers, but not the email body","https://www.googleapis.com/auth/gmail.modify":"Read, compose, and send emails from your Gmail account","https://www.googleapis.com/auth/gmail.readonly":"View your email messages and settings","https://www.googleapis.com/auth/gmail.compose":"Manage drafts and send emails","https://www.googleapis.com/auth/gmail.labels":"See and edit your email labels","https://www.googleapis.com/auth/gmail.insert":"Add emails into your Gmail mailbox","https://www.googleapis.com/auth/gmail.send":"Send email on your behalf"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://mail.google.com/","https://www.googleapis.com/auth/gmail.settings.basic"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/gmail/v1/rest","service":"gmail","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-meet.json b/public/specs/google/google-meet.json index 5d168c8b..dbd92e20 100644 --- a/public/specs/google/google-meet.json +++ b/public/specs/google/google-meet.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Meet API","version":"v2","description":"Create and manage meetings in Google Meet."},"servers":[{"url":"https://meet.googleapis.com/"}],"paths":{"/v2/conferenceRecords":{"get":{"operationId":"meet.conferenceRecords.list","x-executor-toolPath":"meet.conferenceRecords.list","tags":["Google Meet API"],"description":"Lists the conference records. By default, ordered by start time and in descending order. For more information, see [Work with conferences](https://developers.google.com/workspace/meet/api/guides/conferences).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `space.meeting_code` * `space.name` * `start_time` * `end_time` For example, consider the following filters: * `space.name = \"spaces/NAME\"` * `space.meeting_code = \"abc-mnop-xyz\"` * `start_time>=\"2024-01-01T00:00:00.000Z\" AND start_time<=\"2024-01-02T00:00:00.000Z\"` * `end_time IS NULL`","schema":{"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `space.meeting_code` * `space.name` * `start_time` * `end_time` For example, consider the following filters: * `space.name = \"spaces/NAME\"` * `space.meeting_code = \"abc-mnop-xyz\"` * `start_time>=\"2024-01-01T00:00:00.000Z\" AND start_time<=\"2024-01-02T00:00:00.000Z\"` * `end_time IS NULL`","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of conference records to return. The service might return fewer than this value. If unspecified, at most 25 conference records are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of conference records to return. The service might return fewer than this value. If unspecified, at most 25 conference records are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListConferenceRecordsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}":{"get":{"operationId":"meet.conferenceRecords.get","x-executor-toolPath":"meet.conferenceRecords.get","tags":["Google Meet API"],"description":"Gets a conference record by conference ID. For more information, see [Work with conferences](https://developers.google.com/workspace/meet/api/guides/conferences).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}`). Required. Resource name of the conference.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}`). Required. Resource name of the conference.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ConferenceRecord"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/participants/{participantsId}":{"get":{"operationId":"meet.conferenceRecords.participants.get","x-executor-toolPath":"meet.conferenceRecords.participants.get","tags":["Google Meet API"],"description":"Gets a participant by participant ID. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"participantsId","in":"path","required":true,"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","schema":{"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Participant"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}":{"get":{"operationId":"meet.conferenceRecords.participants.participantSessions.get","x-executor-toolPath":"meet.conferenceRecords.participants.participantSessions.get","tags":["Google Meet API"],"description":"Gets a participant session by participant session ID. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"participantsId","in":"path","required":true,"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","schema":{"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"participantSessionsId","in":"path","required":true,"description":"`participantSessionsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","schema":{"description":"`participantSessionsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ParticipantSession"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}":{"get":{"operationId":"meet.conferenceRecords.recordings.get","x-executor-toolPath":"meet.conferenceRecords.recordings.get","tags":["Google Meet API"],"description":"Gets a recording by recording ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","type":"string"},"allowReserved":true},{"name":"recordingsId","in":"path","required":true,"description":"`recordingsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","schema":{"description":"`recordingsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Recording"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}":{"get":{"operationId":"meet.conferenceRecords.smartNotes.get","x-executor-toolPath":"meet.conferenceRecords.smartNotes.get","tags":["Google Meet API"],"description":"Gets smart notes by smart note ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","type":"string"},"allowReserved":true},{"name":"smartNotesId","in":"path","required":true,"description":"`smartNotesId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","schema":{"description":"`smartNotesId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_SmartNote"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}":{"get":{"operationId":"meet.conferenceRecords.transcripts.get","x-executor-toolPath":"meet.conferenceRecords.transcripts.get","tags":["Google Meet API"],"description":"Gets a transcript by transcript ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","type":"string"},"allowReserved":true},{"name":"transcriptsId","in":"path","required":true,"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","schema":{"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Transcript"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}":{"get":{"operationId":"meet.conferenceRecords.transcripts.entries.get","x-executor-toolPath":"meet.conferenceRecords.transcripts.entries.get","tags":["Google Meet API"],"description":"Gets a `TranscriptEntry` resource by entry ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts). Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation.","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","type":"string"},"allowReserved":true},{"name":"transcriptsId","in":"path","required":true,"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","schema":{"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","type":"string"},"allowReserved":true},{"name":"entriesId","in":"path","required":true,"description":"`entriesId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","schema":{"description":"`entriesId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_TranscriptEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/spaces":{"post":{"operationId":"meet.spaces.create","x-executor-toolPath":"meet.spaces.create","tags":["Google Meet API"],"description":"Creates a space. For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/spaces/{spacesId}":{"get":{"operationId":"meet.spaces.get","x-executor-toolPath":"meet.spaces.get","tags":["Google Meet API"],"description":"Gets details about a meeting space. For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces). For an example, see [Get a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#get-meeting-space).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.settings"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly","https://www.googleapis.com/auth/meetings.space.settings"]},"patch":{"operationId":"meet.spaces.patch","x-executor-toolPath":"meet.spaces.patch","tags":["Google Meet API"],"description":"Updates details about a meeting space. For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request.","schema":{"description":"Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.settings"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.settings"]}},"/v2/spaces/{spacesId}/members/{membersId}":{"get":{"operationId":"meet.spaces.members.get","x-executor-toolPath":"meet.spaces.members.get","tags":["Google Meet API"],"description":"Gets a member. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members). This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). When the `fields` parameter is omitted, this API response will default to \"name,email,role,user\".","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]},"patch":{"operationId":"meet.spaces.members.patch","x-executor-toolPath":"meet.spaces.members.patch","tags":["Google Meet API"],"description":"Updates a member. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Field mask used to specify the fields to be updated in the member. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request. In case of BatchUpdate, it must be absent or the same as the update_mask in BatchUpdateMembersRequest when UpdateMemberRequest is built as a child request of BatchUpdateMembersRequest.","schema":{"description":"Optional. Field mask used to specify the fields to be updated in the member. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request. In case of BatchUpdate, it must be absent or the same as the update_mask in BatchUpdateMembersRequest when UpdateMemberRequest is built as a child request of BatchUpdateMembersRequest.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{name}":{"delete":{"operationId":"meet.spaces.members.delete","x-executor-toolPath":"meet.spaces.members.delete","tags":["Google Meet API"],"description":"Deletes the member who was previously assigned roles in the space. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members).","parameters":[{"name":"name","in":"path","required":true,"description":"Required. Format: “spaces/{space}/members/{member}”","schema":{"description":"Required. Format: “spaces/{space}/members/{member}”","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{name}:endActiveConference":{"post":{"operationId":"meet.spaces.endActiveConference","x-executor-toolPath":"meet.spaces.endActiveConference","tags":["Google Meet API"],"description":"Ends an active conference (if there's one). For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces).","parameters":[{"name":"name","in":"path","required":true,"description":"Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","schema":{"description":"Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_EndActiveConferenceRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{parent}/entries":{"get":{"operationId":"meet.conferenceRecords.transcripts.entries.list","x-executor-toolPath":"meet.conferenceRecords.transcripts.entries.list","tags":["Google Meet API"],"description":"Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts). Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of entries to return. The service might return fewer than this value. If unspecified, at most 10 entries are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Maximum number of entries to return. The service might return fewer than this value. If unspecified, at most 10 entries are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListTranscriptEntriesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/members":{"get":{"operationId":"meet.spaces.members.list","x-executor-toolPath":"meet.spaces.members.list","tags":["Google Meet API"],"description":"Lists members. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members). This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). When the `fields` parameter is omitted this API response will default to \"name,email,role,user\".","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: spaces/{space}","schema":{"description":"Required. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of members to return. The service might return fewer than this value. If unspecified or set to 0, at most 250 members are returned. The maximum value is 500; values above 500 are coerced to 500. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of members to return. The service might return fewer than this value. If unspecified or set to 0, at most 250 members are returned. The maximum value is 500; values above 500 are coerced to 500. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListMembersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]},"post":{"operationId":"meet.spaces.members.create","x-executor-toolPath":"meet.spaces.members.create","tags":["Google Meet API"],"description":"Creates a member. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members). This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). When the `fields` parameter is omitted, this API response will default to \"name,email,role,user\".","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: spaces/{space}","schema":{"description":"Required. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{parent}/members:batchUpdate":{"post":{"operationId":"meet.spaces.members.batchUpdate","x-executor-toolPath":"meet.spaces.members.batchUpdate","tags":["Google Meet API"],"description":"Updates members of one space within a batch. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent resource shared by all Members being updated. Format: spaces/{space}","schema":{"description":"Required. The parent resource shared by all Members being updated. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_BatchUpdateMembersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_BatchUpdateMembersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{parent}/participantSessions":{"get":{"operationId":"meet.conferenceRecords.participants.participantSessions.list","x-executor-toolPath":"meet.conferenceRecords.participants.participantSessions.list","tags":["Google Meet API"],"description":"Lists the participant sessions of a participant in a conference record. By default, ordered by join time and in descending order. This API supports `fields` as standard parameters like every other API. However, when the `fields` request parameter is omitted this API defaults to `'participantsessions/*, next_page_token'`. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}/participants/{participant}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}/participants/{participant}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `start_time` * `end_time` For example, `end_time IS NULL` returns active participant sessions in the conference record.","schema":{"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `start_time` * `end_time` For example, `end_time IS NULL` returns active participant sessions in the conference record.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of participant sessions to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of participant sessions to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListParticipantSessionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/participants":{"get":{"operationId":"meet.conferenceRecords.participants.list","x-executor-toolPath":"meet.conferenceRecords.participants.list","tags":["Google Meet API"],"description":"Lists the participants in a conference record. By default, ordered by join time and in descending order. This API supports `fields` as standard parameters like every other API. However, when the `fields` request parameter is omitted, this API defaults to `'participants/*, next_page_token'`. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `earliest_start_time` * `latest_end_time` For example, `latest_end_time IS NULL` returns active participants in the conference.","schema":{"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `earliest_start_time` * `latest_end_time` For example, `latest_end_time IS NULL` returns active participants in the conference.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of participants to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","schema":{"description":"Maximum number of participants to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListParticipantsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/recordings":{"get":{"operationId":"meet.conferenceRecords.recordings.list","x-executor-toolPath":"meet.conferenceRecords.recordings.list","tags":["Google Meet API"],"description":"Lists the recording resources from the conference record. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of recordings to return. The service might return fewer than this value. If unspecified, at most 10 recordings are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Maximum number of recordings to return. The service might return fewer than this value. If unspecified, at most 10 recordings are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListRecordingsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/smartNotes":{"get":{"operationId":"meet.conferenceRecords.smartNotes.list","x-executor-toolPath":"meet.conferenceRecords.smartNotes.list","tags":["Google Meet API"],"description":"Lists the set of smart notes from the conference record. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of smart notes to return. The service might return fewer than this value. If unspecified, at most 10 smart notes are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of smart notes to return. The service might return fewer than this value. If unspecified, at most 10 smart notes are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListSmartNotesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/transcripts":{"get":{"operationId":"meet.conferenceRecords.transcripts.list","x-executor-toolPath":"meet.conferenceRecords.transcripts.list","tags":["Google Meet API"],"description":"Lists the set of transcripts from the conference record. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of transcripts to return. The service might return fewer than this value. If unspecified, at most 10 transcripts are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Maximum number of transcripts to return. The service might return fewer than this value. If unspecified, at most 10 transcripts are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListTranscriptsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}}},"components":{"schemas":{"meet_v2_ActiveConference":{"description":"Active conference.","type":"object","properties":{"conferenceRecord":{"description":"Output only. Reference to 'ConferenceRecord' resource. Format: `conferenceRecords/{conference_record}` where `{conference_record}` is a unique ID for each instance of a call within a space.","readOnly":true,"type":"string"}}},"meet_v2_AnonymousUser":{"description":"User who joins anonymously (meaning not signed into a Google Account).","type":"object","properties":{"displayName":{"description":"Output only. User provided name when they join a conference anonymously.","readOnly":true,"type":"string"}}},"meet_v2_ArtifactConfig":{"description":"Configuration related to meeting artifacts potentially generated by this meeting space.","type":"object","properties":{"recordingConfig":{"$ref":"#/components/schemas/meet_v2_RecordingConfig"},"smartNotesConfig":{"$ref":"#/components/schemas/meet_v2_SmartNotesConfig"},"transcriptionConfig":{"$ref":"#/components/schemas/meet_v2_TranscriptionConfig"}}},"meet_v2_BatchUpdateMembersRequest":{"description":"Request to update members of one space within a batch.","type":"object","properties":{"requests":{"description":"Required. The request message specifying the resources to update. A maximum of 500 members can be modified in a batch.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_UpdateMemberRequest"}},"updateMask":{"description":"Optional. Top-level field mask used to specify the fields to be updated in the member for all UpdateMemberRequests. There are 4 possible scenarios for top-level and child field mask: 1. top-level and child field mask is absent: All fields provided in the requests are updated, including deleting fields not set in the requests. 2. top-level field mask is present but child field mask is absent: The fields specified in the top-level field mask are updated. 3. top-level and child field mask is present: The child field mask must be the same as the top-level field mask. 4. top-level field mask is absent but child field mask is present: It isn't supported and will return an error.","format":"google-fieldmask","type":"string"}}},"meet_v2_BatchUpdateMembersResponse":{"description":"Response of batch update members.","type":"object","properties":{"members":{"description":"Members updated.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Member"}}}},"meet_v2_ConferenceRecord":{"description":"Single instance of a meeting held in a space.","type":"object","properties":{"endTime":{"description":"Output only. Timestamp when the conference ended. Set for past conferences. Unset if the conference is ongoing.","format":"google-datetime","readOnly":true,"type":"string"},"expireTime":{"description":"Output only. Server enforced expiration time for when this conference record resource is deleted. The resource is deleted 30 days after the conference ends.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Identifier. Resource name of the conference record. Format: `conferenceRecords/{conference_record}` where `{conference_record}` is a unique ID for each instance of a call within a space.","type":"string"},"space":{"description":"Output only. The space where the conference was held.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the conference started. Always set.","format":"google-datetime","readOnly":true,"type":"string"}}},"meet_v2_DocsDestination":{"description":"Google Docs location where the transcript file is saved.","type":"object","properties":{"document":{"description":"Output only. The document ID for the underlying Google Docs transcript file. For example, \"1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP\". Use the `documents.get` method of the Google Docs API (https://developers.google.com/docs/api/reference/rest/v1/documents/get) to fetch the content.","readOnly":true,"type":"string"},"exportUri":{"description":"Output only. URI for the Google Docs transcript file. Use `https://docs.google.com/document/d/{$DocumentId}/view` to browse the transcript in the browser.","readOnly":true,"type":"string"}}},"meet_v2_DriveDestination":{"description":"Export location where a recording file is saved in Google Drive.","type":"object","properties":{"exportUri":{"description":"Output only. Link used to play back the recording file in the browser. For example, `https://drive.google.com/file/d/{$fileId}/view`.","readOnly":true,"type":"string"},"file":{"description":"Output only. The `fileId` for the underlying MP4 file. For example, \"1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP\". Use `$ GET https://www.googleapis.com/drive/v3/files/{$fileId}?alt=media` to download the blob. For more information, see https://developers.google.com/drive/api/v3/reference/files/get.","readOnly":true,"type":"string"}}},"meet_v2_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"meet_v2_EndActiveConferenceRequest":{"description":"Request to end an ongoing conference of a space.","type":"object"},"meet_v2_GatewaySipAccess":{"description":"Details how to join the conference through a SIP gateway.","type":"object","properties":{"sipAccessCode":{"description":"The permanent numeric code for manual entry on specially configured devices.","type":"string"},"uri":{"description":"The Session Initiation Protocol (SIP) URI the conference can be reached through. The string is in one of these formats: * \"sip:USER_ID@GATEWAY_ADDRESS\" * \"sips:USER_ID@GATEWAY_ADDRESS\" where USER_ID is the 13-digit universal pin (with the future option to support using a Meet meeting code as well), and GATEWAY_ADDRESS is a valid address to be resolved using a DNS SRV lookup, or a dotted quad.","type":"string"}}},"meet_v2_ListConferenceRecordsResponse":{"description":"Response of ListConferenceRecords method.","type":"object","properties":{"conferenceRecords":{"description":"List of conferences in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_ConferenceRecord"}},"nextPageToken":{"description":"Token to be circulated back for further List call if current List does NOT include all the Conferences. Unset if all conferences have been returned.","type":"string"}}},"meet_v2_ListMembersResponse":{"description":"Response of list members.","type":"object","properties":{"members":{"description":"The list of members for the current page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Member"}},"nextPageToken":{"description":"Token to be circulated back for further list call if current list doesn't include all the members. Unset if all members are returned.","type":"string"}}},"meet_v2_ListParticipantSessionsResponse":{"description":"Response of ListParticipants method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the participants. Unset if all participants are returned.","type":"string"},"participantSessions":{"description":"List of participants in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_ParticipantSession"}}}},"meet_v2_ListParticipantsResponse":{"description":"Response of ListParticipants method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the participants. Unset if all participants are returned.","type":"string"},"participants":{"description":"List of participants in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Participant"}},"totalSize":{"description":"Total, exact number of `participants`. By default, this field isn't included in the response. Set the field mask in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters) to receive this field in the response.","format":"int32","type":"integer"}}},"meet_v2_ListRecordingsResponse":{"description":"Response for ListRecordings method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the recordings. Unset if all recordings are returned.","type":"string"},"recordings":{"description":"List of recordings in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Recording"}}}},"meet_v2_ListSmartNotesResponse":{"description":"Response for ListSmartNotes method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the smart notes. Unset if all smart notes are returned.","type":"string"},"smartNotes":{"description":"List of smart notes in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_SmartNote"}}}},"meet_v2_ListTranscriptEntriesResponse":{"description":"Response for ListTranscriptEntries method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the transcript entries. Unset if all entries are returned.","type":"string"},"transcriptEntries":{"description":"List of TranscriptEntries in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_TranscriptEntry"}}}},"meet_v2_ListTranscriptsResponse":{"description":"Response for ListTranscripts method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the transcripts. Unset if all transcripts are returned.","type":"string"},"transcripts":{"description":"List of transcripts in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Transcript"}}}},"meet_v2_Member":{"description":"Users who are configured to have a role in the space. These users can join the space without knocking.","type":"object","properties":{"email":{"description":"Email for the member. This is required for creating the member.","type":"string"},"name":{"description":"Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","type":"string"},"role":{"description":"The meeting role assigned to the member.","enum":["ROLE_UNSPECIFIED","COHOST"],"type":"string"}}},"meet_v2_ModerationRestrictions":{"description":"Defines restrictions for features when the meeting is moderated.","type":"object","properties":{"chatRestriction":{"description":"Defines who has permission to send chat messages in the meeting space.","enum":["RESTRICTION_TYPE_UNSPECIFIED","HOSTS_ONLY","NO_RESTRICTION"],"type":"string"},"defaultJoinAsViewerType":{"description":"Defines whether to restrict the default role assigned to users as viewer.","enum":["DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"},"presentRestriction":{"description":"Defines who has permission to share their screen in the meeting space.","enum":["RESTRICTION_TYPE_UNSPECIFIED","HOSTS_ONLY","NO_RESTRICTION"],"type":"string"},"reactionRestriction":{"description":"Defines who has permission to send reactions in the meeting space.","enum":["RESTRICTION_TYPE_UNSPECIFIED","HOSTS_ONLY","NO_RESTRICTION"],"type":"string"}}},"meet_v2_Participant":{"description":"User who attended or is attending a conference.","type":"object","properties":{"anonymousUser":{"$ref":"#/components/schemas/meet_v2_AnonymousUser"},"earliestStartTime":{"description":"Output only. Time when the participant first joined the meeting.","format":"google-datetime","readOnly":true,"type":"string"},"latestEndTime":{"description":"Output only. Time when the participant left the meeting for the last time. This can be null if it's an active meeting.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the participant. Format: `conferenceRecords/{conference_record}/participants/{participant}`","readOnly":true,"type":"string"},"phoneUser":{"$ref":"#/components/schemas/meet_v2_PhoneUser"},"signedinUser":{"$ref":"#/components/schemas/meet_v2_SignedinUser"}}},"meet_v2_ParticipantSession":{"description":"Refers to each unique join or leave session when a user joins a conference from a device. Note that any time a user joins the conference a new unique ID is assigned. That means if a user joins a space multiple times from the same device, they're assigned different IDs, and are also be treated as different participant sessions.","type":"object","properties":{"endTime":{"description":"Output only. Timestamp when the user session ends. Unset if the user session hasn’t ended.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Identifier. Session id.","type":"string"},"startTime":{"description":"Output only. Timestamp when the user session starts.","format":"google-datetime","readOnly":true,"type":"string"}}},"meet_v2_PhoneAccess":{"description":"Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number.","type":"object","properties":{"languageCode":{"description":"The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: \"es-419\" for Latin American Spanish, \"fr-CA\" for Canadian French.","type":"string"},"phoneNumber":{"description":"The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character.","type":"string"},"pin":{"description":"The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary.","type":"string"},"regionCode":{"description":"The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: \"SE\" for Sweden.","type":"string"}}},"meet_v2_PhoneUser":{"description":"User dialing in from a phone where the user's identity is unknown because they haven't signed in with a Google Account.","type":"object","properties":{"displayName":{"description":"Output only. Partially redacted user's phone number when calling.","readOnly":true,"type":"string"}}},"meet_v2_Recording":{"description":"Metadata about a recording created during a conference.","type":"object","properties":{"driveDestination":{"$ref":"#/components/schemas/meet_v2_DriveDestination"},"endTime":{"description":"Output only. Timestamp when the recording ended.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the recording. Format: `conferenceRecords/{conference_record}/recordings/{recording}` where `{recording}` is a 1:1 mapping to each unique recording session during the conference.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the recording started.","format":"google-datetime","readOnly":true,"type":"string"},"state":{"description":"Output only. Current state.","readOnly":true,"enum":["STATE_UNSPECIFIED","STARTED","ENDED","FILE_GENERATED"],"type":"string"}}},"meet_v2_RecordingConfig":{"description":"Configuration related to recording in a meeting space.","type":"object","properties":{"autoRecordingGeneration":{"description":"Defines whether a meeting space is automatically recorded when someone with the privilege to record joins the meeting.","enum":["AUTO_GENERATION_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"}}},"meet_v2_SignedinUser":{"description":"A signed-in user can be: a) An individual joining from a personal computer, mobile device, or through companion mode. b) A robot account used by conference room devices.","type":"object","properties":{"displayName":{"description":"Output only. For a personal device, it's the user's first name and last name. For a robot account, it's the administrator-specified device name. For example, \"Altostrat Room\".","readOnly":true,"type":"string"},"user":{"description":"Output only. Unique ID for the user. Interoperable with Admin SDK API and People API. Format: `users/{user}`","readOnly":true,"type":"string"}}},"meet_v2_SmartNote":{"description":"Metadata for a smart note generated from a conference. It refers to the notes generated from Take Notes with Gemini during the conference.","type":"object","properties":{"docsDestination":{"$ref":"#/components/schemas/meet_v2_DocsDestination"},"endTime":{"description":"Output only. Timestamp when the smart notes stopped.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Identifier. Resource name of the smart notes. Format: `conferenceRecords/{conference_record}/smartNotes/{smart_note}`, where `{smart_note}` is a 1:1 mapping to each unique smart notes session of the conference.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the smart notes started.","format":"google-datetime","readOnly":true,"type":"string"},"state":{"description":"Output only. Current state.","readOnly":true,"enum":["STATE_UNSPECIFIED","STARTED","ENDED","FILE_GENERATED"],"type":"string"}}},"meet_v2_SmartNotesConfig":{"description":"Configuration related to smart notes in a meeting space. For more information about smart notes, see [\"Take notes for me\" in Google Meet](https://support.google.com/meet/answer/14754931).","type":"object","properties":{"autoSmartNotesGeneration":{"description":"Defines whether to automatically generate a summary and recap of the meeting for all invitees in the organization when someone with the privilege to enable smart notes joins the meeting.","enum":["AUTO_GENERATION_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"}}},"meet_v2_Space":{"description":"Virtual place where conferences are held. Only one active conference can be held in one space at any given time.","type":"object","properties":{"activeConference":{"$ref":"#/components/schemas/meet_v2_ActiveConference"},"config":{"$ref":"#/components/schemas/meet_v2_SpaceConfig"},"gatewaySipAccess":{"description":"Output only. The SIP-based access methods that can be used to join the conference. Can be empty.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/meet_v2_GatewaySipAccess"}},"meetingCode":{"description":"Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.","readOnly":true,"type":"string"},"meetingUri":{"description":"Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.","readOnly":true,"type":"string"},"name":{"description":"Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"phoneAccess":{"description":"Output only. All regional phone access methods for this meeting space. Can be empty.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/meet_v2_PhoneAccess"}}}},"meet_v2_SpaceConfig":{"description":"The configuration pertaining to a meeting space.","type":"object","properties":{"accessType":{"description":"Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED.","enum":["ACCESS_TYPE_UNSPECIFIED","OPEN","TRUSTED","RESTRICTED"],"type":"string"},"artifactConfig":{"$ref":"#/components/schemas/meet_v2_ArtifactConfig"},"attendanceReportGenerationType":{"description":"Whether attendance report is enabled for the meeting space.","enum":["ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED","GENERATE_REPORT","DO_NOT_GENERATE"],"type":"string"},"entryPointAccess":{"description":"Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL","enum":["ENTRY_POINT_ACCESS_UNSPECIFIED","ALL","CREATOR_APP_ONLY"],"type":"string"},"moderation":{"description":"The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.","enum":["MODERATION_UNSPECIFIED","OFF","ON"],"type":"string"},"moderationRestrictions":{"$ref":"#/components/schemas/meet_v2_ModerationRestrictions"}}},"meet_v2_Transcript":{"description":"Metadata for a transcript generated from a conference. It refers to the ASR (Automatic Speech Recognition) result of user's speech during the conference.","type":"object","properties":{"docsDestination":{"$ref":"#/components/schemas/meet_v2_DocsDestination"},"endTime":{"description":"Output only. Timestamp when the transcript stopped.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the transcript. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`, where `{transcript}` is a 1:1 mapping to each unique transcription session of the conference.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the transcript started.","format":"google-datetime","readOnly":true,"type":"string"},"state":{"description":"Output only. Current state.","readOnly":true,"enum":["STATE_UNSPECIFIED","STARTED","ENDED","FILE_GENERATED"],"type":"string"}}},"meet_v2_TranscriptEntry":{"description":"Single entry for one user’s speech during a transcript session.","type":"object","properties":{"endTime":{"description":"Output only. Timestamp when the transcript entry ended.","format":"google-datetime","readOnly":true,"type":"string"},"languageCode":{"description":"Output only. Language of spoken text, such as \"en-US\". IETF BCP 47 syntax (https://tools.ietf.org/html/bcp47)","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the entry. Format: \"conferenceRecords/{conference_record}/transcripts/{transcript}/entries/{entry}\"","readOnly":true,"type":"string"},"participant":{"description":"Output only. Refers to the participant who speaks.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the transcript entry started.","format":"google-datetime","readOnly":true,"type":"string"},"text":{"description":"Output only. The transcribed text of the participant's voice, at maximum 10K words. Note that the limit is subject to change.","readOnly":true,"type":"string"}}},"meet_v2_TranscriptionConfig":{"description":"Configuration related to transcription in a meeting space.","type":"object","properties":{"autoTranscriptionGeneration":{"description":"Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.","enum":["AUTO_GENERATION_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"}}},"meet_v2_UpdateMemberRequest":{"description":"Request to update a member.","type":"object","properties":{"member":{"$ref":"#/components/schemas/meet_v2_Member"},"updateMask":{"description":"Optional. Field mask used to specify the fields to be updated in the member. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request. In case of BatchUpdate, it must be absent or the same as the update_mask in BatchUpdateMembersRequest when UpdateMemberRequest is built as a child request of BatchUpdateMembersRequest.","format":"google-fieldmask","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/meetings.space.created":"","https://www.googleapis.com/auth/meetings.space.readonly":"","https://www.googleapis.com/auth/meetings.space.settings":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly","https://www.googleapis.com/auth/meetings.space.settings"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/meet/v2/rest","service":"meet","version":"v2"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Meet API","version":"v2","description":"Create and manage meetings in Google Meet."},"servers":[{"url":"https://meet.googleapis.com/"}],"paths":{"/v2/conferenceRecords":{"get":{"operationId":"meet.conferenceRecords.list","x-executor-toolPath":"meet.conferenceRecords.list","tags":["Google Meet API"],"description":"Lists the conference records. By default, ordered by start time and in descending order. For more information, see [Work with conferences](https://developers.google.com/workspace/meet/api/guides/conferences).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `space.meeting_code` * `space.name` * `start_time` * `end_time` For example, consider the following filters: * `space.name = \"spaces/NAME\"` * `space.meeting_code = \"abc-mnop-xyz\"` * `start_time>=\"2024-01-01T00:00:00.000Z\" AND start_time<=\"2024-01-02T00:00:00.000Z\"` * `end_time IS NULL`","schema":{"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `space.meeting_code` * `space.name` * `start_time` * `end_time` For example, consider the following filters: * `space.name = \"spaces/NAME\"` * `space.meeting_code = \"abc-mnop-xyz\"` * `start_time>=\"2024-01-01T00:00:00.000Z\" AND start_time<=\"2024-01-02T00:00:00.000Z\"` * `end_time IS NULL`","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of conference records to return. The service might return fewer than this value. If unspecified, at most 25 conference records are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of conference records to return. The service might return fewer than this value. If unspecified, at most 25 conference records are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListConferenceRecordsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}":{"get":{"operationId":"meet.conferenceRecords.get","x-executor-toolPath":"meet.conferenceRecords.get","tags":["Google Meet API"],"description":"Gets a conference record by conference ID. For more information, see [Work with conferences](https://developers.google.com/workspace/meet/api/guides/conferences).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}`). Required. Resource name of the conference.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}`). Required. Resource name of the conference.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ConferenceRecord"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/participants/{participantsId}":{"get":{"operationId":"meet.conferenceRecords.participants.get","x-executor-toolPath":"meet.conferenceRecords.participants.get","tags":["Google Meet API"],"description":"Gets a participant by participant ID. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"participantsId","in":"path","required":true,"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","schema":{"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Participant"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}":{"get":{"operationId":"meet.conferenceRecords.participants.participantSessions.get","x-executor-toolPath":"meet.conferenceRecords.participants.participantSessions.get","tags":["Google Meet API"],"description":"Gets a participant session by participant session ID. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"participantsId","in":"path","required":true,"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","schema":{"description":"`participantsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"participantSessionsId","in":"path","required":true,"description":"`participantSessionsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","schema":{"description":"`participantSessionsId` of `name` (`conferenceRecords/{conferenceRecordsId}/participants/{participantsId}/participantSessions/{participantSessionsId}`). Required. Resource name of the participant.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ParticipantSession"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}":{"get":{"operationId":"meet.conferenceRecords.recordings.get","x-executor-toolPath":"meet.conferenceRecords.recordings.get","tags":["Google Meet API"],"description":"Gets a recording by recording ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","type":"string"},"allowReserved":true},{"name":"recordingsId","in":"path","required":true,"description":"`recordingsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","schema":{"description":"`recordingsId` of `name` (`conferenceRecords/{conferenceRecordsId}/recordings/{recordingsId}`). Required. Resource name of the recording.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Recording"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}":{"get":{"operationId":"meet.conferenceRecords.smartNotes.get","x-executor-toolPath":"meet.conferenceRecords.smartNotes.get","tags":["Google Meet API"],"description":"Gets smart notes by smart note ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","type":"string"},"allowReserved":true},{"name":"smartNotesId","in":"path","required":true,"description":"`smartNotesId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","schema":{"description":"`smartNotesId` of `name` (`conferenceRecords/{conferenceRecordsId}/smartNotes/{smartNotesId}`). Required. Resource name of the smart note. Format: conferenceRecords/{conference_record}/smartNotes/{smart_note}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_SmartNote"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}":{"get":{"operationId":"meet.conferenceRecords.transcripts.get","x-executor-toolPath":"meet.conferenceRecords.transcripts.get","tags":["Google Meet API"],"description":"Gets a transcript by transcript ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","type":"string"},"allowReserved":true},{"name":"transcriptsId","in":"path","required":true,"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","schema":{"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}`). Required. Resource name of the transcript.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Transcript"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}":{"get":{"operationId":"meet.conferenceRecords.transcripts.entries.get","x-executor-toolPath":"meet.conferenceRecords.transcripts.entries.get","tags":["Google Meet API"],"description":"Gets a `TranscriptEntry` resource by entry ID. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts). Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation.","parameters":[{"name":"conferenceRecordsId","in":"path","required":true,"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","schema":{"description":"`conferenceRecordsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","type":"string"},"allowReserved":true},{"name":"transcriptsId","in":"path","required":true,"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","schema":{"description":"`transcriptsId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","type":"string"},"allowReserved":true},{"name":"entriesId","in":"path","required":true,"description":"`entriesId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","schema":{"description":"`entriesId` of `name` (`conferenceRecords/{conferenceRecordsId}/transcripts/{transcriptsId}/entries/{entriesId}`). Required. Resource name of the `TranscriptEntry`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_TranscriptEntry"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/spaces":{"post":{"operationId":"meet.spaces.create","x-executor-toolPath":"meet.spaces.create","tags":["Google Meet API"],"description":"Creates a space. For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/spaces/{spacesId}":{"get":{"operationId":"meet.spaces.get","x-executor-toolPath":"meet.spaces.get","tags":["Google Meet API"],"description":"Gets details about a meeting space. For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces). For an example, see [Get a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#get-meeting-space).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.settings"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly","https://www.googleapis.com/auth/meetings.space.settings"]},"patch":{"operationId":"meet.spaces.patch","x-executor-toolPath":"meet.spaces.patch","tags":["Google Meet API"],"description":"Updates details about a meeting space. For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}`). Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}`). Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request.","schema":{"description":"Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Space"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.settings"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.settings"]}},"/v2/spaces/{spacesId}/members/{membersId}":{"get":{"operationId":"meet.spaces.members.get","x-executor-toolPath":"meet.spaces.members.get","tags":["Google Meet API"],"description":"Gets a member. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members). This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). When the `fields` parameter is omitted, this API response will default to \"name,email,role,user\".","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Required. Format: “spaces/{space}/members/{member}”","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]},"patch":{"operationId":"meet.spaces.members.patch","x-executor-toolPath":"meet.spaces.members.patch","tags":["Google Meet API"],"description":"Updates a member. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members).","parameters":[{"name":"spacesId","in":"path","required":true,"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","schema":{"description":"`spacesId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","type":"string"},"allowReserved":true},{"name":"membersId","in":"path","required":true,"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","schema":{"description":"`membersId` of `name` (`spaces/{spacesId}/members/{membersId}`). Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Optional. Field mask used to specify the fields to be updated in the member. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request. In case of BatchUpdate, it must be absent or the same as the update_mask in BatchUpdateMembersRequest when UpdateMemberRequest is built as a child request of BatchUpdateMembersRequest.","schema":{"description":"Optional. Field mask used to specify the fields to be updated in the member. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request. In case of BatchUpdate, it must be absent or the same as the update_mask in BatchUpdateMembersRequest when UpdateMemberRequest is built as a child request of BatchUpdateMembersRequest.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{name}":{"delete":{"operationId":"meet.spaces.members.delete","x-executor-toolPath":"meet.spaces.members.delete","tags":["Google Meet API"],"description":"Deletes the member who was previously assigned roles in the space. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members).","parameters":[{"name":"name","in":"path","required":true,"description":"Required. Format: “spaces/{space}/members/{member}”","schema":{"description":"Required. Format: “spaces/{space}/members/{member}”","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{name}:endActiveConference":{"post":{"operationId":"meet.spaces.endActiveConference","x-executor-toolPath":"meet.spaces.endActiveConference","tags":["Google Meet API"],"description":"Ends an active conference (if there's one). For more information, see [Manage meeting spaces](https://developers.google.com/workspace/meet/api/guides/manage-meeting-spaces).","parameters":[{"name":"name","in":"path","required":true,"description":"Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","schema":{"description":"Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_EndActiveConferenceRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{parent}/entries":{"get":{"operationId":"meet.conferenceRecords.transcripts.entries.list","x-executor-toolPath":"meet.conferenceRecords.transcripts.entries.list","tags":["Google Meet API"],"description":"Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts). Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when 1) we have interleaved speakers within milliseconds, or 2) the Google Docs transcript file is modified after generation.","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of entries to return. The service might return fewer than this value. If unspecified, at most 10 entries are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Maximum number of entries to return. The service might return fewer than this value. If unspecified, at most 10 entries are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListTranscriptEntriesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/members":{"get":{"operationId":"meet.spaces.members.list","x-executor-toolPath":"meet.spaces.members.list","tags":["Google Meet API"],"description":"Lists members. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members). This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). When the `fields` parameter is omitted this API response will default to \"name,email,role,user\".","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: spaces/{space}","schema":{"description":"Required. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of members to return. The service might return fewer than this value. If unspecified or set to 0, at most 250 members are returned. The maximum value is 500; values above 500 are coerced to 500. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of members to return. The service might return fewer than this value. If unspecified or set to 0, at most 250 members are returned. The maximum value is 500; values above 500 are coerced to 500. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListMembersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]},"post":{"operationId":"meet.spaces.members.create","x-executor-toolPath":"meet.spaces.members.create","tags":["Google Meet API"],"description":"Creates a member. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members). This API supports the `fields` parameter in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters). When the `fields` parameter is omitted, this API response will default to \"name,email,role,user\".","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: spaces/{space}","schema":{"description":"Required. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_Member"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{parent}/members:batchUpdate":{"post":{"operationId":"meet.spaces.members.batchUpdate","x-executor-toolPath":"meet.spaces.members.batchUpdate","tags":["Google Meet API"],"description":"Updates members of one space within a batch. For more information, see [Manage meeting space members](https://developers.google.com/workspace/meet/api/guides/meeting-space-members).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. The parent resource shared by all Members being updated. Format: spaces/{space}","schema":{"description":"Required. The parent resource shared by all Members being updated. Format: spaces/{space}","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_BatchUpdateMembersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_BatchUpdateMembersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created"]}},"/v2/{parent}/participantSessions":{"get":{"operationId":"meet.conferenceRecords.participants.participantSessions.list","x-executor-toolPath":"meet.conferenceRecords.participants.participantSessions.list","tags":["Google Meet API"],"description":"Lists the participant sessions of a participant in a conference record. By default, ordered by join time and in descending order. This API supports `fields` as standard parameters like every other API. However, when the `fields` request parameter is omitted this API defaults to `'participantsessions/*, next_page_token'`. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}/participants/{participant}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}/participants/{participant}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `start_time` * `end_time` For example, `end_time IS NULL` returns active participant sessions in the conference record.","schema":{"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `start_time` * `end_time` For example, `end_time IS NULL` returns active participant sessions in the conference record.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of participant sessions to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of participant sessions to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListParticipantSessionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/participants":{"get":{"operationId":"meet.conferenceRecords.participants.list","x-executor-toolPath":"meet.conferenceRecords.participants.list","tags":["Google Meet API"],"description":"Lists the participants in a conference record. By default, ordered by join time and in descending order. This API supports `fields` as standard parameters like every other API. However, when the `fields` request parameter is omitted, this API defaults to `'participants/*, next_page_token'`. For more information, see [Work with participants](https://developers.google.com/workspace/meet/api/guides/participants).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filter","in":"query","required":false,"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `earliest_start_time` * `latest_end_time` For example, `latest_end_time IS NULL` returns active participants in the conference.","schema":{"description":"Optional. User specified filtering condition in [EBNF format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form). The following are the filterable fields: * `earliest_start_time` * `latest_end_time` For example, `latest_end_time IS NULL` returns active participants in the conference.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of participants to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","schema":{"description":"Maximum number of participants to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListParticipantsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/recordings":{"get":{"operationId":"meet.conferenceRecords.recordings.list","x-executor-toolPath":"meet.conferenceRecords.recordings.list","tags":["Google Meet API"],"description":"Lists the recording resources from the conference record. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of recordings to return. The service might return fewer than this value. If unspecified, at most 10 recordings are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Maximum number of recordings to return. The service might return fewer than this value. If unspecified, at most 10 recordings are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListRecordingsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/smartNotes":{"get":{"operationId":"meet.conferenceRecords.smartNotes.list","x-executor-toolPath":"meet.conferenceRecords.smartNotes.list","tags":["Google Meet API"],"description":"Lists the set of smart notes from the conference record. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. Maximum number of smart notes to return. The service might return fewer than this value. If unspecified, at most 10 smart notes are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Optional. Maximum number of smart notes to return. The service might return fewer than this value. If unspecified, at most 10 smart notes are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. Page token returned from previous List Call.","schema":{"description":"Optional. Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListSmartNotesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}},"/v2/{parent}/transcripts":{"get":{"operationId":"meet.conferenceRecords.transcripts.list","x-executor-toolPath":"meet.conferenceRecords.transcripts.list","tags":["Google Meet API"],"description":"Lists the set of transcripts from the conference record. By default, ordered by start time and in ascending order. For more information, see [Work with artifacts](https://developers.google.com/workspace/meet/api/guides/artifacts).","parameters":[{"name":"parent","in":"path","required":true,"description":"Required. Format: `conferenceRecords/{conference_record}`","schema":{"description":"Required. Format: `conferenceRecords/{conference_record}`","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of transcripts to return. The service might return fewer than this value. If unspecified, at most 10 transcripts are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","schema":{"description":"Maximum number of transcripts to return. The service might return fewer than this value. If unspecified, at most 10 transcripts are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Page token returned from previous List Call.","schema":{"description":"Page token returned from previous List Call.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meet_v2_ListTranscriptsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.created"]},{"googleOAuth2":["https://www.googleapis.com/auth/meetings.space.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly"]}}},"components":{"schemas":{"meet_v2_ActiveConference":{"description":"Active conference.","type":"object","properties":{"conferenceRecord":{"description":"Output only. Reference to 'ConferenceRecord' resource. Format: `conferenceRecords/{conference_record}` where `{conference_record}` is a unique ID for each instance of a call within a space.","readOnly":true,"type":"string"}}},"meet_v2_AnonymousUser":{"description":"User who joins anonymously (meaning not signed into a Google Account).","type":"object","properties":{"displayName":{"description":"Output only. User provided name when they join a conference anonymously.","readOnly":true,"type":"string"}}},"meet_v2_ArtifactConfig":{"description":"Configuration related to meeting artifacts potentially generated by this meeting space.","type":"object","properties":{"recordingConfig":{"$ref":"#/components/schemas/meet_v2_RecordingConfig"},"smartNotesConfig":{"$ref":"#/components/schemas/meet_v2_SmartNotesConfig"},"transcriptionConfig":{"$ref":"#/components/schemas/meet_v2_TranscriptionConfig"}}},"meet_v2_BatchUpdateMembersRequest":{"description":"Request to update members of one space within a batch.","type":"object","properties":{"requests":{"description":"Required. The request message specifying the resources to update. A maximum of 500 members can be modified in a batch.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_UpdateMemberRequest"}},"updateMask":{"description":"Optional. Top-level field mask used to specify the fields to be updated in the member for all UpdateMemberRequests. There are 4 possible scenarios for top-level and child field mask: 1. top-level and child field mask is absent: All fields provided in the requests are updated, including deleting fields not set in the requests. 2. top-level field mask is present but child field mask is absent: The fields specified in the top-level field mask are updated. 3. top-level and child field mask is present: The child field mask must be the same as the top-level field mask. 4. top-level field mask is absent but child field mask is present: It isn't supported and will return an error.","format":"google-fieldmask","type":"string"}}},"meet_v2_BatchUpdateMembersResponse":{"description":"Response of batch update members.","type":"object","properties":{"members":{"description":"Members updated.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Member"}}}},"meet_v2_ConferenceRecord":{"description":"Single instance of a meeting held in a space.","type":"object","properties":{"endTime":{"description":"Output only. Timestamp when the conference ended. Set for past conferences. Unset if the conference is ongoing.","format":"google-datetime","readOnly":true,"type":"string"},"expireTime":{"description":"Output only. Server enforced expiration time for when this conference record resource is deleted. The resource is deleted 30 days after the conference ends.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Identifier. Resource name of the conference record. Format: `conferenceRecords/{conference_record}` where `{conference_record}` is a unique ID for each instance of a call within a space.","type":"string"},"space":{"description":"Output only. The space where the conference was held.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the conference started. Always set.","format":"google-datetime","readOnly":true,"type":"string"}}},"meet_v2_DocsDestination":{"description":"Google Docs location where the transcript file is saved.","type":"object","properties":{"document":{"description":"Output only. The document ID for the underlying Google Docs transcript file. For example, \"1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP\". Use the `documents.get` method of the Google Docs API (https://developers.google.com/docs/api/reference/rest/v1/documents/get) to fetch the content.","readOnly":true,"type":"string"},"exportUri":{"description":"Output only. URI for the Google Docs transcript file. Use `https://docs.google.com/document/d/{$DocumentId}/view` to browse the transcript in the browser.","readOnly":true,"type":"string"}}},"meet_v2_DriveDestination":{"description":"Export location where a recording file is saved in Google Drive.","type":"object","properties":{"exportUri":{"description":"Output only. Link used to play back the recording file in the browser. For example, `https://drive.google.com/file/d/{$fileId}/view`.","readOnly":true,"type":"string"},"file":{"description":"Output only. The `fileId` for the underlying MP4 file. For example, \"1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP\". Use `$ GET https://www.googleapis.com/drive/v3/files/{$fileId}?alt=media` to download the blob. For more information, see https://developers.google.com/drive/api/v3/reference/files/get.","readOnly":true,"type":"string"}}},"meet_v2_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"meet_v2_EndActiveConferenceRequest":{"description":"Request to end an ongoing conference of a space.","type":"object"},"meet_v2_GatewaySipAccess":{"description":"Details how to join the conference through a SIP gateway.","type":"object","properties":{"sipAccessCode":{"description":"The permanent numeric code for manual entry on specially configured devices.","type":"string"},"uri":{"description":"The Session Initiation Protocol (SIP) URI the conference can be reached through. The string is in one of these formats: * \"sip:USER_ID@GATEWAY_ADDRESS\" * \"sips:USER_ID@GATEWAY_ADDRESS\" where USER_ID is the 13-digit universal pin (with the future option to support using a Meet meeting code as well), and GATEWAY_ADDRESS is a valid address to be resolved using a DNS SRV lookup, or a dotted quad.","type":"string"}}},"meet_v2_ListConferenceRecordsResponse":{"description":"Response of ListConferenceRecords method.","type":"object","properties":{"conferenceRecords":{"description":"List of conferences in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_ConferenceRecord"}},"nextPageToken":{"description":"Token to be circulated back for further List call if current List does NOT include all the Conferences. Unset if all conferences have been returned.","type":"string"}}},"meet_v2_ListMembersResponse":{"description":"Response of list members.","type":"object","properties":{"members":{"description":"The list of members for the current page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Member"}},"nextPageToken":{"description":"Token to be circulated back for further list call if current list doesn't include all the members. Unset if all members are returned.","type":"string"}}},"meet_v2_ListParticipantSessionsResponse":{"description":"Response of ListParticipants method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the participants. Unset if all participants are returned.","type":"string"},"participantSessions":{"description":"List of participants in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_ParticipantSession"}}}},"meet_v2_ListParticipantsResponse":{"description":"Response of ListParticipants method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the participants. Unset if all participants are returned.","type":"string"},"participants":{"description":"List of participants in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Participant"}},"totalSize":{"description":"Total, exact number of `participants`. By default, this field isn't included in the response. Set the field mask in [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters) to receive this field in the response.","format":"int32","type":"integer"}}},"meet_v2_ListRecordingsResponse":{"description":"Response for ListRecordings method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the recordings. Unset if all recordings are returned.","type":"string"},"recordings":{"description":"List of recordings in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Recording"}}}},"meet_v2_ListSmartNotesResponse":{"description":"Response for ListSmartNotes method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the smart notes. Unset if all smart notes are returned.","type":"string"},"smartNotes":{"description":"List of smart notes in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_SmartNote"}}}},"meet_v2_ListTranscriptEntriesResponse":{"description":"Response for ListTranscriptEntries method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the transcript entries. Unset if all entries are returned.","type":"string"},"transcriptEntries":{"description":"List of TranscriptEntries in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_TranscriptEntry"}}}},"meet_v2_ListTranscriptsResponse":{"description":"Response for ListTranscripts method.","type":"object","properties":{"nextPageToken":{"description":"Token to be circulated back for further List call if current List doesn't include all the transcripts. Unset if all transcripts are returned.","type":"string"},"transcripts":{"description":"List of transcripts in one page.","type":"array","items":{"$ref":"#/components/schemas/meet_v2_Transcript"}}}},"meet_v2_Member":{"description":"Users who are configured to have a role in the space. These users can join the space without knocking.","type":"object","properties":{"email":{"description":"Email for the member. This is required for creating the member.","type":"string"},"name":{"description":"Identifier. Resource name of the member. Format: spaces/{space}/members/{member}","type":"string"},"role":{"description":"The meeting role assigned to the member.","enum":["ROLE_UNSPECIFIED","COHOST"],"type":"string"}}},"meet_v2_ModerationRestrictions":{"description":"Defines restrictions for features when the meeting is moderated.","type":"object","properties":{"chatRestriction":{"description":"Defines who has permission to send chat messages in the meeting space.","enum":["RESTRICTION_TYPE_UNSPECIFIED","HOSTS_ONLY","NO_RESTRICTION"],"type":"string"},"defaultJoinAsViewerType":{"description":"Defines whether to restrict the default role assigned to users as viewer.","enum":["DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"},"presentRestriction":{"description":"Defines who has permission to share their screen in the meeting space.","enum":["RESTRICTION_TYPE_UNSPECIFIED","HOSTS_ONLY","NO_RESTRICTION"],"type":"string"},"reactionRestriction":{"description":"Defines who has permission to send reactions in the meeting space.","enum":["RESTRICTION_TYPE_UNSPECIFIED","HOSTS_ONLY","NO_RESTRICTION"],"type":"string"}}},"meet_v2_Participant":{"description":"User who attended or is attending a conference.","type":"object","properties":{"anonymousUser":{"$ref":"#/components/schemas/meet_v2_AnonymousUser"},"earliestStartTime":{"description":"Output only. Time when the participant first joined the meeting.","format":"google-datetime","readOnly":true,"type":"string"},"latestEndTime":{"description":"Output only. Time when the participant left the meeting for the last time. This can be null if it's an active meeting.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the participant. Format: `conferenceRecords/{conference_record}/participants/{participant}`","readOnly":true,"type":"string"},"phoneUser":{"$ref":"#/components/schemas/meet_v2_PhoneUser"},"signedinUser":{"$ref":"#/components/schemas/meet_v2_SignedinUser"}}},"meet_v2_ParticipantSession":{"description":"Refers to each unique join or leave session when a user joins a conference from a device. Note that any time a user joins the conference a new unique ID is assigned. That means if a user joins a space multiple times from the same device, they're assigned different IDs, and are also be treated as different participant sessions.","type":"object","properties":{"endTime":{"description":"Output only. Timestamp when the user session ends. Unset if the user session hasn’t ended.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Identifier. Session id.","type":"string"},"startTime":{"description":"Output only. Timestamp when the user session starts.","format":"google-datetime","readOnly":true,"type":"string"}}},"meet_v2_PhoneAccess":{"description":"Phone access contains information required to dial into a conference using a regional phone number and a PIN that is specific to that phone number.","type":"object","properties":{"languageCode":{"description":"The BCP 47/LDML language code for the language associated with this phone access. To be parsed by the i18n LanguageCode utility. Examples: \"es-419\" for Latin American Spanish, \"fr-CA\" for Canadian French.","type":"string"},"phoneNumber":{"description":"The phone number to dial for this meeting space in E.164 format. Full phone number with a leading '+' character.","type":"string"},"pin":{"description":"The PIN that users must enter after dialing the given number. The PIN consists of only decimal digits and the length may vary.","type":"string"},"regionCode":{"description":"The CLDR/ISO 3166 region code for the country associated with this phone access. To be parsed by the i18n RegionCode utility. Example: \"SE\" for Sweden.","type":"string"}}},"meet_v2_PhoneUser":{"description":"User dialing in from a phone where the user's identity is unknown because they haven't signed in with a Google Account.","type":"object","properties":{"displayName":{"description":"Output only. Partially redacted user's phone number when calling.","readOnly":true,"type":"string"}}},"meet_v2_Recording":{"description":"Metadata about a recording created during a conference.","type":"object","properties":{"driveDestination":{"$ref":"#/components/schemas/meet_v2_DriveDestination"},"endTime":{"description":"Output only. Timestamp when the recording ended.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the recording. Format: `conferenceRecords/{conference_record}/recordings/{recording}` where `{recording}` is a 1:1 mapping to each unique recording session during the conference.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the recording started.","format":"google-datetime","readOnly":true,"type":"string"},"state":{"description":"Output only. Current state.","readOnly":true,"enum":["STATE_UNSPECIFIED","STARTED","ENDED","FILE_GENERATED"],"type":"string"}}},"meet_v2_RecordingConfig":{"description":"Configuration related to recording in a meeting space.","type":"object","properties":{"autoRecordingGeneration":{"description":"Defines whether a meeting space is automatically recorded when someone with the privilege to record joins the meeting.","enum":["AUTO_GENERATION_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"}}},"meet_v2_SignedinUser":{"description":"A signed-in user can be: a) An individual joining from a personal computer, mobile device, or through companion mode. b) A robot account used by conference room devices.","type":"object","properties":{"displayName":{"description":"Output only. For a personal device, it's the user's first name and last name. For a robot account, it's the administrator-specified device name. For example, \"Altostrat Room\".","readOnly":true,"type":"string"},"user":{"description":"Output only. Unique ID for the user. Interoperable with Admin SDK API and People API. Format: `users/{user}`","readOnly":true,"type":"string"}}},"meet_v2_SmartNote":{"description":"Metadata for a smart note generated from a conference. It refers to the notes generated from Take Notes with Gemini during the conference.","type":"object","properties":{"docsDestination":{"$ref":"#/components/schemas/meet_v2_DocsDestination"},"endTime":{"description":"Output only. Timestamp when the smart notes stopped.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Identifier. Resource name of the smart notes. Format: `conferenceRecords/{conference_record}/smartNotes/{smart_note}`, where `{smart_note}` is a 1:1 mapping to each unique smart notes session of the conference.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the smart notes started.","format":"google-datetime","readOnly":true,"type":"string"},"state":{"description":"Output only. Current state.","readOnly":true,"enum":["STATE_UNSPECIFIED","STARTED","ENDED","FILE_GENERATED"],"type":"string"}}},"meet_v2_SmartNotesConfig":{"description":"Configuration related to smart notes in a meeting space. For more information about smart notes, see [\"Take notes for me\" in Google Meet](https://support.google.com/meet/answer/14754931).","type":"object","properties":{"autoSmartNotesGeneration":{"description":"Defines whether to automatically generate a summary and recap of the meeting for all invitees in the organization when someone with the privilege to enable smart notes joins the meeting.","enum":["AUTO_GENERATION_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"}}},"meet_v2_Space":{"description":"Virtual place where conferences are held. Only one active conference can be held in one space at any given time.","type":"object","properties":{"activeConference":{"$ref":"#/components/schemas/meet_v2_ActiveConference"},"config":{"$ref":"#/components/schemas/meet_v2_SpaceConfig"},"gatewaySipAccess":{"description":"Output only. The SIP-based access methods that can be used to join the conference. Can be empty.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/meet_v2_GatewaySipAccess"}},"meetingCode":{"description":"Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.","readOnly":true,"type":"string"},"meetingUri":{"description":"Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.","readOnly":true,"type":"string"},"name":{"description":"Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/workspace/meet/api/guides/meeting-spaces#identify-meeting-space).","type":"string"},"phoneAccess":{"description":"Output only. All regional phone access methods for this meeting space. Can be empty.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/meet_v2_PhoneAccess"}}}},"meet_v2_SpaceConfig":{"description":"The configuration pertaining to a meeting space.","type":"object","properties":{"accessType":{"description":"Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED.","enum":["ACCESS_TYPE_UNSPECIFIED","OPEN","TRUSTED","RESTRICTED"],"type":"string"},"artifactConfig":{"$ref":"#/components/schemas/meet_v2_ArtifactConfig"},"attendanceReportGenerationType":{"description":"Whether attendance report is enabled for the meeting space.","enum":["ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED","GENERATE_REPORT","DO_NOT_GENERATE"],"type":"string"},"entryPointAccess":{"description":"Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL","enum":["ENTRY_POINT_ACCESS_UNSPECIFIED","ALL","CREATOR_APP_ONLY"],"type":"string"},"moderation":{"description":"The pre-configured moderation mode for the Meeting. Default: Controlled by the user's policies.","enum":["MODERATION_UNSPECIFIED","OFF","ON"],"type":"string"},"moderationRestrictions":{"$ref":"#/components/schemas/meet_v2_ModerationRestrictions"}}},"meet_v2_Transcript":{"description":"Metadata for a transcript generated from a conference. It refers to the ASR (Automatic Speech Recognition) result of user's speech during the conference.","type":"object","properties":{"docsDestination":{"$ref":"#/components/schemas/meet_v2_DocsDestination"},"endTime":{"description":"Output only. Timestamp when the transcript stopped.","format":"google-datetime","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the transcript. Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`, where `{transcript}` is a 1:1 mapping to each unique transcription session of the conference.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the transcript started.","format":"google-datetime","readOnly":true,"type":"string"},"state":{"description":"Output only. Current state.","readOnly":true,"enum":["STATE_UNSPECIFIED","STARTED","ENDED","FILE_GENERATED"],"type":"string"}}},"meet_v2_TranscriptEntry":{"description":"Single entry for one user’s speech during a transcript session.","type":"object","properties":{"endTime":{"description":"Output only. Timestamp when the transcript entry ended.","format":"google-datetime","readOnly":true,"type":"string"},"languageCode":{"description":"Output only. Language of spoken text, such as \"en-US\". IETF BCP 47 syntax (https://tools.ietf.org/html/bcp47)","readOnly":true,"type":"string"},"name":{"description":"Output only. Resource name of the entry. Format: \"conferenceRecords/{conference_record}/transcripts/{transcript}/entries/{entry}\"","readOnly":true,"type":"string"},"participant":{"description":"Output only. Refers to the participant who speaks.","readOnly":true,"type":"string"},"startTime":{"description":"Output only. Timestamp when the transcript entry started.","format":"google-datetime","readOnly":true,"type":"string"},"text":{"description":"Output only. The transcribed text of the participant's voice, at maximum 10K words. Note that the limit is subject to change.","readOnly":true,"type":"string"}}},"meet_v2_TranscriptionConfig":{"description":"Configuration related to transcription in a meeting space.","type":"object","properties":{"autoTranscriptionGeneration":{"description":"Defines whether the content of a meeting is automatically transcribed when someone with the privilege to transcribe joins the meeting.","enum":["AUTO_GENERATION_TYPE_UNSPECIFIED","ON","OFF"],"type":"string"}}},"meet_v2_UpdateMemberRequest":{"description":"Request to update a member.","type":"object","properties":{"member":{"$ref":"#/components/schemas/meet_v2_Member"},"updateMask":{"description":"Optional. Field mask used to specify the fields to be updated in the member. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request. In case of BatchUpdate, it must be absent or the same as the update_mask in BatchUpdateMembersRequest when UpdateMemberRequest is built as a child request of BatchUpdateMembersRequest.","format":"google-fieldmask","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/meetings.space.created":"Create, edit, and see information about your Google Meet conferences created by the app.","https://www.googleapis.com/auth/meetings.space.readonly":"Read information about any of your Google Meet conferences","https://www.googleapis.com/auth/meetings.space.settings":"Edit, and see settings for all of your Google Meet calls."}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/meetings.space.created","https://www.googleapis.com/auth/meetings.space.readonly","https://www.googleapis.com/auth/meetings.space.settings"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/meet/v2/rest","service":"meet","version":"v2"}]}} \ No newline at end of file diff --git a/public/specs/google/google-people.json b/public/specs/google/google-people.json index fd31d2a8..cdd5fd52 100644 --- a/public/specs/google/google-people.json +++ b/public/specs/google/google-people.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"People API","version":"v1","description":"Provides access to information about profiles and contacts."},"servers":[{"url":"https://people.googleapis.com/"}],"paths":{"/v1/contactGroups":{"get":{"operationId":"people.contactGroups.list","x-executor-toolPath":"people.contactGroups.list","tags":["People API"],"description":"List all contact groups owned by the authenticated user. Members of the contact groups are not populated.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"groupFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","schema":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.","schema":{"description":"Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.","schema":{"description":"Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.","schema":{"description":"Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListContactGroupsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]},"post":{"operationId":"people.contactGroups.create","x-executor-toolPath":"people.contactGroups.create","tags":["People API"],"description":"Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_CreateContactGroupRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ContactGroup"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/contactGroups/{contactGroupsId}":{"get":{"operationId":"people.contactGroups.get","x-executor-toolPath":"people.contactGroups.get","tags":["People API"],"description":"Get a specific contact group owned by the authenticated user by specifying a contact group resource name.","parameters":[{"name":"contactGroupsId","in":"path","required":true,"description":"`contactGroupsId` of `resourceName` (`contactGroups/{contactGroupsId}`). Required. The resource name of the contact group to get.","schema":{"description":"`contactGroupsId` of `resourceName` (`contactGroups/{contactGroupsId}`). Required. The resource name of the contact group to get.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"groupFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","schema":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxMembers","in":"query","required":false,"description":"Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.","schema":{"description":"Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ContactGroup"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/contactGroups:batchGet":{"get":{"operationId":"people.contactGroups.batchGet","x-executor-toolPath":"people.contactGroups.batchGet","tags":["People API"],"description":"Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"groupFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","schema":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxMembers","in":"query","required":false,"description":"Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.","schema":{"description":"Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"resourceNames","in":"query","required":true,"description":"Required. The resource names of the contact groups to get. There is a maximum of 200 resource names.","schema":{"type":"array","items":{"description":"Required. The resource names of the contact groups to get. There is a maximum of 200 resource names.","type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchGetContactGroupsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/otherContacts":{"get":{"operationId":"people.otherContacts.list","x-executor-toolPath":"people.otherContacts.list","tags":["People API"],"description":"List all \"Other contacts\", that is contacts that are not in a contact group. \"Other contacts\" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an [google.rpc.ErrorInfo](https://cloud.google.com/apis/design/errors#error_info) with reason \"EXPIRED_SYNC_TOKEN\". In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of \"Other contacts\" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of \"Other contacts\" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"requestSyncToken","in":"query","required":false,"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.","schema":{"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.","type":"boolean"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.","schema":{"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListOtherContactsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.other.readonly"]}},"/v1/otherContacts:search":{"get":{"operationId":"people.otherContacts.search","x-executor-toolPath":"people.otherContacts.search","tags":["People API"],"description":"Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","schema":{"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":true,"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","schema":{"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_SearchResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.other.readonly"]}},"/v1/people/{peopleId}":{"get":{"operationId":"people.people.get","x-executor-toolPath":"people.people.get","tags":["People API"],"description":"Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.","parameters":[{"name":"peopleId","in":"path","required":true,"description":"`peopleId` of `resourceName` (`people/{peopleId}`). Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.","schema":{"description":"`peopleId` of `resourceName` (`people/{peopleId}`). Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestMask.includeField","in":"query","required":false,"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","schema":{"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["openid"]},{"googleOAuth2":["email"]},{"googleOAuth2":["profile"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.addresses.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.birthday.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.emails.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.gender.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.organization.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.phonenumbers.read"]}],"x-google-scopes":["openid","email","profile","https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly","https://www.googleapis.com/auth/directory.readonly","https://www.googleapis.com/auth/user.addresses.read","https://www.googleapis.com/auth/user.birthday.read","https://www.googleapis.com/auth/user.emails.read","https://www.googleapis.com/auth/user.gender.read","https://www.googleapis.com/auth/user.organization.read","https://www.googleapis.com/auth/user.phonenumbers.read"]}},"/v1/people:batchCreateContacts":{"post":{"operationId":"people.people.batchCreateContacts","x-executor-toolPath":"people.people.batchCreateContacts","tags":["People API"],"description":"Create a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchCreateContactsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchCreateContactsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:batchDeleteContacts":{"post":{"operationId":"people.people.batchDeleteContacts","x-executor-toolPath":"people.people.batchDeleteContacts","tags":["People API"],"description":"Delete a batch of contacts. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchDeleteContactsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:batchGet":{"get":{"operationId":"people.people.getBatchGet","x-executor-toolPath":"people.people.getBatchGet","tags":["People API"],"description":"Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestMask.includeField","in":"query","required":false,"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","schema":{"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"resourceNames","in":"query","required":true,"description":"Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&resourceNames=&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. There is a maximum of 200 resource names.","schema":{"type":"array","items":{"description":"Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&resourceNames=&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. There is a maximum of 200 resource names.","type":"string"}},"style":"form","explode":true},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_GetPeopleResponse"}}}}},"security":[{"googleOAuth2":["openid"]},{"googleOAuth2":["email"]},{"googleOAuth2":["profile"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.addresses.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.birthday.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.emails.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.gender.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.organization.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.phonenumbers.read"]}],"x-google-scopes":["openid","email","profile","https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly","https://www.googleapis.com/auth/directory.readonly","https://www.googleapis.com/auth/user.addresses.read","https://www.googleapis.com/auth/user.birthday.read","https://www.googleapis.com/auth/user.emails.read","https://www.googleapis.com/auth/user.gender.read","https://www.googleapis.com/auth/user.organization.read","https://www.googleapis.com/auth/user.phonenumbers.read"]}},"/v1/people:batchUpdateContacts":{"post":{"operationId":"people.people.batchUpdateContacts","x-executor-toolPath":"people.people.batchUpdateContacts","tags":["People API"],"description":"Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchUpdateContactsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchUpdateContactsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:createContact":{"post":{"operationId":"people.people.createContact","x-executor-toolPath":"people.people.createContact","tags":["People API"],"description":"Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:listDirectoryPeople":{"get":{"operationId":"people.people.listDirectoryPeople","x-executor-toolPath":"people.people.listDirectoryPeople","tags":["People API"],"description":"Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directory_people_that_have_changed).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mergeSources","in":"query","required":false,"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","schema":{"type":"array","items":{"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","enum":["DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_MERGE_SOURCE_TYPE_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"requestSyncToken","in":"query","required":false,"description":"Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.","schema":{"description":"Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.","type":"boolean"},"style":"form","explode":false},{"name":"sources","in":"query","required":true,"description":"Required. Directory sources to return.","schema":{"type":"array","items":{"description":"Required. Directory sources to return.","enum":["DIRECTORY_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT","DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE"],"type":"string"}},"style":"form","explode":true},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.","schema":{"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListDirectoryPeopleResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/directory.readonly"]}},"/v1/people:searchContacts":{"get":{"operationId":"people.people.searchContacts","x-executor-toolPath":"people.people.searchContacts","tags":["People API"],"description":"Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","schema":{"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":true,"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","schema":{"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_SearchResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:searchDirectoryPeople":{"get":{"operationId":"people.people.searchDirectoryPeople","x-executor-toolPath":"people.people.searchDirectoryPeople","tags":["People API"],"description":"Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mergeSources","in":"query","required":false,"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","schema":{"type":"array","items":{"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","enum":["DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_MERGE_SOURCE_TYPE_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":true,"description":"Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.","schema":{"description":"Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":true,"description":"Required. Directory sources to return.","schema":{"type":"array","items":{"description":"Required. Directory sources to return.","enum":["DIRECTORY_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT","DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_SearchDirectoryPeopleResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/directory.readonly"]}},"/v1/{resourceName}":{"put":{"operationId":"people.contactGroups.update","x-executor-toolPath":"people.contactGroups.update","tags":["People API"],"description":"Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.","schema":{"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_UpdateContactGroupRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ContactGroup"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]},"delete":{"operationId":"people.contactGroups.delete","x-executor-toolPath":"people.contactGroups.delete","tags":["People API"],"description":"Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact group to delete.","schema":{"description":"Required. The resource name of the contact group to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleteContacts","in":"query","required":false,"description":"Optional. Set to true to also delete the contacts in the specified group.","schema":{"description":"Optional. Set to true to also delete the contacts in the specified group.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}/connections":{"get":{"operationId":"people.people.connections.list","x-executor-toolPath":"people.people.connections.list","tags":["People API"],"description":"Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an [google.rpc.ErrorInfo](https://cloud.google.com/apis/design/errors#error_info) with reason \"EXPIRED_SYNC_TOKEN\". In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's contacts that have changed](/people/v1/contacts#list_the_users_contacts_that_have_changed).","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name to return connections for. Only `people/me` is valid.","schema":{"description":"Required. The resource name to return connections for. Only `people/me` is valid.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestMask.includeField","in":"query","required":false,"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","schema":{"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"requestSyncToken","in":"query","required":false,"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.","schema":{"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.","type":"boolean"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.","schema":{"description":"Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.","enum":["LAST_MODIFIED_ASCENDING","LAST_MODIFIED_DESCENDING","FIRST_NAME_ASCENDING","LAST_NAME_ASCENDING"],"type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.","schema":{"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListConnectionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}/members:modify":{"post":{"operationId":"people.contactGroups.members.modify","x-executor-toolPath":"people.contactGroups.members.modify","tags":["People API"],"description":"Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact group to modify.","schema":{"description":"Required. The resource name of the contact group to modify.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ModifyContactGroupMembersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ModifyContactGroupMembersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:copyOtherContactToMyContactsGroup":{"post":{"operationId":"people.otherContacts.copyOtherContactToMyContactsGroup","x-executor-toolPath":"people.otherContacts.copyOtherContactToMyContactsGroup","tags":["People API"],"description":"Copies an \"Other contact\" to a new contact in the user's \"myContacts\" group Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the \"Other contact\" to copy.","schema":{"description":"Required. The resource name of the \"Other contact\" to copy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_CopyOtherContactToMyContactsGroupRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly"]}},"/v1/{resourceName}:deleteContact":{"delete":{"operationId":"people.people.deleteContact","x-executor-toolPath":"people.people.deleteContact","tags":["People API"],"description":"Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact to delete.","schema":{"description":"Required. The resource name of the contact to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:deleteContactPhoto":{"delete":{"operationId":"people.people.deleteContactPhoto","x-executor-toolPath":"people.people.deleteContactPhoto","tags":["People API"],"description":"Delete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact whose photo will be deleted.","schema":{"description":"Required. The resource name of the contact whose photo will be deleted.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_DeleteContactPhotoResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:updateContact":{"patch":{"operationId":"people.people.updateContact","x-executor-toolPath":"people.people.updateContact","tags":["People API"],"description":"Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `\"failedPrecondition\"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. If making sequential updates to the same person, the etag from the `updateContact` response should be used to avoid failures. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.","schema":{"description":"The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"updatePersonFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:updateContactPhoto":{"patch":{"operationId":"people.people.updateContactPhoto","x-executor-toolPath":"people.people.updateContactPhoto","tags":["People API"],"description":"Update a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. Person resource name","schema":{"description":"Required. Person resource name","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_UpdateContactPhotoRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_UpdateContactPhotoResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}}},"components":{"schemas":{"people_v1_Address":{"description":"A person's physical address. May be a P.O. box or street address. All fields are optional.","type":"object","properties":{"city":{"description":"The city of the address.","type":"string"},"country":{"description":"The country of the address.","type":"string"},"countryCode":{"description":"The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.","type":"string"},"extendedAddress":{"description":"The extended address of the address; for example, the apartment number.","type":"string"},"formattedType":{"description":"Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"formattedValue":{"description":"The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"poBox":{"description":"The P.O. box of the address.","type":"string"},"postalCode":{"description":"The postal code of the address.","type":"string"},"region":{"description":"The region of the address; for example, the state or province.","type":"string"},"streetAddress":{"description":"The street address.","type":"string"},"type":{"description":"The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`","type":"string"}}},"people_v1_AgeRangeType":{"description":"A person's age range.","type":"object","properties":{"ageRange":{"description":"The age range.","enum":["AGE_RANGE_UNSPECIFIED","LESS_THAN_EIGHTEEN","EIGHTEEN_TO_TWENTY","TWENTY_ONE_OR_OLDER"],"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"}}},"people_v1_BatchCreateContactsRequest":{"description":"A request to create a batch of contacts.","type":"object","properties":{"contacts":{"description":"Required. The contact to create. Allows up to 200 contacts in a single request.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ContactToCreate"}},"readMask":{"description":"Required. A field mask to restrict which fields on each person are returned in the response. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"sources":{"description":"Optional. A mask of what source types to return in the post mutate read. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}}},"required":["contacts","readMask"]},"people_v1_BatchCreateContactsResponse":{"description":"If not successful, returns BatchCreateContactsErrorDetails which contains a list of errors for each invalid contact. The response to a request to create a batch of contacts.","type":"object","properties":{"createdPeople":{"description":"The contacts that were created, unless the request `read_mask` is empty.","type":"array","items":{"$ref":"#/components/schemas/people_v1_PersonResponse"}}}},"people_v1_BatchDeleteContactsRequest":{"description":"A request to delete a batch of existing contacts.","type":"object","properties":{"resourceNames":{"description":"Required. The resource names of the contact to delete. It's repeatable. Allows up to 500 resource names in a single request.","type":"array","items":{"type":"string"}}},"required":["resourceNames"]},"people_v1_BatchGetContactGroupsResponse":{"description":"The response to a batch get contact groups request.","type":"object","properties":{"responses":{"description":"The list of responses for each requested contact group resource.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ContactGroupResponse"}}}},"people_v1_BatchUpdateContactsRequest":{"description":"A request to update a batch of contacts.","type":"object","properties":{"contacts":{"description":"Required. A map of resource names to the person data to be updated. Allows up to 200 contacts in a single request.","type":"object","additionalProperties":{"$ref":"#/components/schemas/people_v1_Person"}},"readMask":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"sources":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"updateMask":{"description":"Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All specified fields will be replaced, or cleared if left empty for each person. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined","format":"google-fieldmask","type":"string"}},"required":["contacts","updateMask","readMask"]},"people_v1_BatchUpdateContactsResponse":{"description":"If not successful, returns BatchUpdateContactsErrorDetails, a list of errors corresponding to each contact. The response to a request to update a batch of contacts.","type":"object","properties":{"updateResult":{"description":"A map of resource names to the contacts that were updated, unless the request `read_mask` is empty.","type":"object","additionalProperties":{"$ref":"#/components/schemas/people_v1_PersonResponse"}}}},"people_v1_Biography":{"description":"A person's short biography.","type":"object","properties":{"contentType":{"description":"The content type of the biography.","enum":["CONTENT_TYPE_UNSPECIFIED","TEXT_PLAIN","TEXT_HTML"],"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The short biography.","type":"string"}}},"people_v1_Birthday":{"description":"A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to. Clients should always set the `date` field when mutating birthdays.","type":"object","properties":{"date":{"$ref":"#/components/schemas/people_v1_Date"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"text":{"description":"Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.","type":"string"}}},"people_v1_BraggingRights":{"description":"**DEPRECATED**: No data will be returned A person's bragging rights.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The bragging rights; for example, `climbed mount everest`.","type":"string"}}},"people_v1_CalendarUrl":{"description":"A person's calendar URL.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`","type":"string"},"url":{"description":"The calendar URL.","type":"string"}}},"people_v1_ClientData":{"description":"Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.","type":"object","properties":{"key":{"description":"The client specified key of the client data.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The client specified value of the client data.","type":"string"}}},"people_v1_ContactGroup":{"description":"A contact group.","type":"object","properties":{"clientData":{"description":"The group's client data.","type":"array","items":{"$ref":"#/components/schemas/people_v1_GroupClientData"}},"etag":{"description":"The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.","type":"string"},"formattedName":{"description":"Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.","readOnly":true,"type":"string"},"groupType":{"description":"Output only. The contact group type.","readOnly":true,"enum":["GROUP_TYPE_UNSPECIFIED","USER_CONTACT_GROUP","SYSTEM_CONTACT_GROUP"],"type":"string"},"memberCount":{"description":"Output only. The total number of contacts in the group irrespective of max members in specified in the request.","format":"int32","readOnly":true,"type":"integer"},"memberResourceNames":{"description":"Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.","readOnly":true,"type":"array","items":{"type":"string"}},"metadata":{"$ref":"#/components/schemas/people_v1_ContactGroupMetadata"},"name":{"description":"The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.","type":"string"},"resourceName":{"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.","type":"string"}}},"people_v1_ContactGroupMembership":{"description":"A Google contact group membership.","type":"object","properties":{"contactGroupId":{"description":"Output only. The contact group ID for the contact group membership.","readOnly":true,"type":"string"},"contactGroupResourceName":{"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or \"myContacts\" or \"starred\" system groups memberships can be added. A contact must always have at least one contact group membership.","type":"string"}}},"people_v1_ContactGroupMetadata":{"description":"The metadata about a contact group.","type":"object","properties":{"deleted":{"description":"Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.","readOnly":true,"type":"boolean"},"updateTime":{"description":"Output only. The time the group was last updated.","format":"google-datetime","readOnly":true,"type":"string"}}},"people_v1_ContactGroupResponse":{"description":"The response for a specific contact group.","type":"object","properties":{"contactGroup":{"$ref":"#/components/schemas/people_v1_ContactGroup"},"requestedResourceName":{"description":"The original requested resource name.","type":"string"},"status":{"$ref":"#/components/schemas/people_v1_Status"}}},"people_v1_ContactToCreate":{"description":"A wrapper that contains the person data to populate a newly created source.","type":"object","properties":{"contactPerson":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_CopyOtherContactToMyContactsGroupRequest":{"description":"A request to copy an \"Other contact\" to my contacts group.","type":"object","properties":{"copyMask":{"description":"Required. A field mask to restrict which fields are copied into the new contact. Valid values are: * emailAddresses * names * phoneNumbers","format":"google-fieldmask","type":"string"},"readMask":{"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"sources":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}}},"required":["copyMask"]},"people_v1_CoverPhoto":{"description":"A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.","type":"object","properties":{"default":{"description":"True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"url":{"description":"The URL of the cover photo.","type":"string"}}},"people_v1_CreateContactGroupRequest":{"description":"A request to create a new contact group.","type":"object","properties":{"contactGroup":{"$ref":"#/components/schemas/people_v1_ContactGroup"},"readGroupFields":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name","format":"google-fieldmask","type":"string"}},"required":["contactGroup"]},"people_v1_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":{"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.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"people_v1_DeleteContactPhotoResponse":{"description":"The response for deleting a contact's photo.","type":"object","properties":{"person":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_DomainMembership":{"description":"A Google Workspace Domain membership.","type":"object","properties":{"inViewerDomain":{"description":"True if the person is in the viewer's Google Workspace domain.","type":"boolean"}}},"people_v1_EmailAddress":{"description":"A person's email address.","type":"object","properties":{"displayName":{"description":"The display name of the email.","type":"string"},"formattedType":{"description":"Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`","type":"string"},"value":{"description":"The email address.","type":"string"}}},"people_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"people_v1_Event":{"description":"An event related to the person.","type":"object","properties":{"date":{"$ref":"#/components/schemas/people_v1_Date"},"formattedType":{"description":"Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`","type":"string"}}},"people_v1_ExternalId":{"description":"An identifier from an external entity related to the person.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`","type":"string"},"value":{"description":"The value of the external ID.","type":"string"}}},"people_v1_FieldMetadata":{"description":"Metadata about a field.","type":"object","properties":{"primary":{"description":"Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.","readOnly":true,"type":"boolean"},"source":{"$ref":"#/components/schemas/people_v1_Source"},"sourcePrimary":{"description":"True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.","type":"boolean"},"verified":{"description":"Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.","readOnly":true,"type":"boolean"}}},"people_v1_FileAs":{"description":"The name that should be used to sort the person in a list.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The file-as value","type":"string"}}},"people_v1_Gender":{"description":"A person's gender.","type":"object","properties":{"addressMeAs":{"description":"Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`","type":"string"},"formattedValue":{"description":"Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`","type":"string"}}},"people_v1_GetPeopleResponse":{"description":"The response to a get request for a list of people by resource name.","type":"object","properties":{"responses":{"description":"The response for each requested resource name.","type":"array","items":{"$ref":"#/components/schemas/people_v1_PersonResponse"}}}},"people_v1_GroupClientData":{"description":"Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.","type":"object","properties":{"key":{"description":"The client specified key of the client data.","type":"string"},"value":{"description":"The client specified value of the client data.","type":"string"}}},"people_v1_ImClient":{"description":"A person's instant messaging client.","type":"object","properties":{"formattedProtocol":{"description":"Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"formattedType":{"description":"Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"protocol":{"description":"The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`","type":"string"},"type":{"description":"The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`","type":"string"},"username":{"description":"The user name used in the IM client.","type":"string"}}},"people_v1_Interest":{"description":"One of the person's interests.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The interest; for example, `stargazing`.","type":"string"}}},"people_v1_ListConnectionsResponse":{"description":"The response to a request for the authenticated user's connections.","type":"object","properties":{"connections":{"description":"The list of people that the requestor is connected to.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}},"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"nextSyncToken":{"description":"A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token. When the response is paginated, only the last page will contain `nextSyncToken`.","type":"string"},"totalItems":{"description":"The total number of items in the list without pagination.","format":"int32","type":"integer"},"totalPeople":{"description":"**DEPRECATED** (Please use totalItems) The total number of people in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_ListContactGroupsResponse":{"description":"The response to a list contact groups request.","type":"object","properties":{"contactGroups":{"description":"The list of contact groups. Members of the contact groups are not populated.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ContactGroup"}},"nextPageToken":{"description":"The token that can be used to retrieve the next page of results.","type":"string"},"nextSyncToken":{"description":"The token that can be used to retrieve changes since the last request.","type":"string"},"totalItems":{"description":"The total number of items in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_ListDirectoryPeopleResponse":{"description":"The response to a request for the authenticated user's domain directory.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"nextSyncToken":{"description":"A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.","type":"string"},"people":{"description":"The list of people in the domain directory.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}}}},"people_v1_ListOtherContactsResponse":{"description":"The response to a request for the authenticated user's \"Other contacts\".","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"nextSyncToken":{"description":"A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.","type":"string"},"otherContacts":{"description":"The list of \"Other contacts\" returned as Person resources. \"Other contacts\" support a limited subset of fields. See ListOtherContactsRequest.request_mask for more detailed information.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}},"totalSize":{"description":"The total number of other contacts in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_Locale":{"description":"A person's locale preference.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.","type":"string"}}},"people_v1_Location":{"description":"A person's location.","type":"object","properties":{"buildingId":{"description":"The building identifier.","type":"string"},"current":{"description":"Whether the location is the current location.","type":"boolean"},"deskCode":{"description":"The individual desk location.","type":"string"},"floor":{"description":"The floor name or number.","type":"string"},"floorSection":{"description":"The floor section in `floor_name`.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`","type":"string"},"value":{"description":"The free-form value of the location.","type":"string"}}},"people_v1_Membership":{"description":"A person's membership in a group. Only contact group memberships can be modified.","type":"object","properties":{"contactGroupMembership":{"$ref":"#/components/schemas/people_v1_ContactGroupMembership"},"domainMembership":{"$ref":"#/components/schemas/people_v1_DomainMembership"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"}}},"people_v1_MiscKeyword":{"description":"A person's miscellaneous keyword.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The miscellaneous keyword type.","enum":["TYPE_UNSPECIFIED","OUTLOOK_BILLING_INFORMATION","OUTLOOK_DIRECTORY_SERVER","OUTLOOK_KEYWORD","OUTLOOK_MILEAGE","OUTLOOK_PRIORITY","OUTLOOK_SENSITIVITY","OUTLOOK_SUBJECT","OUTLOOK_USER","HOME","WORK","OTHER"],"type":"string"},"value":{"description":"The value of the miscellaneous keyword.","type":"string"}}},"people_v1_ModifyContactGroupMembersRequest":{"description":"A request to modify an existing contact group's members. Contacts can be removed from any group but they can only be added to a user group or \"myContacts\" or \"starred\" system groups.","type":"object","properties":{"resourceNamesToAdd":{"description":"Optional. The resource names of the contact people to add in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.","type":"array","items":{"type":"string"}},"resourceNamesToRemove":{"description":"Optional. The resource names of the contact people to remove in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.","type":"array","items":{"type":"string"}}}},"people_v1_ModifyContactGroupMembersResponse":{"description":"The response to a modify contact group members request.","type":"object","properties":{"canNotRemoveLastContactGroupResourceNames":{"description":"The contact people resource names that cannot be removed from their last contact group.","type":"array","items":{"type":"string"}},"notFoundResourceNames":{"description":"The contact people resource names that were not found.","type":"array","items":{"type":"string"}}}},"people_v1_Name":{"description":"A person's name. If the name is a mononym, the family name is empty.","type":"object","properties":{"displayName":{"description":"Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.","readOnly":true,"type":"string"},"displayNameLastFirst":{"description":"Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.","readOnly":true,"type":"string"},"familyName":{"description":"The family name.","type":"string"},"givenName":{"description":"The given name.","type":"string"},"honorificPrefix":{"description":"The honorific prefixes, such as `Mrs.` or `Dr.`","type":"string"},"honorificSuffix":{"description":"The honorific suffixes, such as `Jr.`","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"middleName":{"description":"The middle name(s).","type":"string"},"phoneticFamilyName":{"description":"The family name spelled as it sounds.","type":"string"},"phoneticFullName":{"description":"The full name spelled as it sounds.","type":"string"},"phoneticGivenName":{"description":"The given name spelled as it sounds.","type":"string"},"phoneticHonorificPrefix":{"description":"The honorific prefixes spelled as they sound.","type":"string"},"phoneticHonorificSuffix":{"description":"The honorific suffixes spelled as they sound.","type":"string"},"phoneticMiddleName":{"description":"The middle name(s) spelled as they sound.","type":"string"},"unstructuredName":{"description":"The free form name value.","type":"string"}}},"people_v1_Nickname":{"description":"A person's nickname.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the nickname.","enum":["DEFAULT","MAIDEN_NAME","INITIALS","GPLUS","OTHER_NAME","ALTERNATE_NAME","SHORT_NAME"],"type":"string"},"value":{"description":"The nickname.","type":"string"}}},"people_v1_Occupation":{"description":"A person's occupation.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The occupation; for example, `carpenter`.","type":"string"}}},"people_v1_Organization":{"description":"A person's past or current organization. Overlapping date ranges are permitted.","type":"object","properties":{"costCenter":{"description":"The person's cost center at the organization.","type":"string"},"current":{"description":"True if the organization is the person's current organization; false if the organization is a past organization.","type":"boolean"},"department":{"description":"The person's department at the organization.","type":"string"},"domain":{"description":"The domain name associated with the organization; for example, `google.com`.","type":"string"},"endDate":{"$ref":"#/components/schemas/people_v1_Date"},"formattedType":{"description":"Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"fullTimeEquivalentMillipercent":{"description":"The person's full-time equivalent millipercent within the organization (100000 = 100%).","format":"int32","type":"integer"},"jobDescription":{"description":"The person's job description at the organization.","type":"string"},"location":{"description":"The location of the organization office the person works at.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"name":{"description":"The name of the organization.","type":"string"},"phoneticName":{"description":"The phonetic name of the organization.","type":"string"},"startDate":{"$ref":"#/components/schemas/people_v1_Date"},"symbol":{"description":"The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.","type":"string"},"title":{"description":"The person's job title at the organization.","type":"string"},"type":{"description":"The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`","type":"string"}}},"people_v1_Person":{"description":"Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.","type":"object","properties":{"addresses":{"description":"The person's street addresses.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Address"}},"ageRange":{"description":"Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.","readOnly":true,"enum":["AGE_RANGE_UNSPECIFIED","LESS_THAN_EIGHTEEN","EIGHTEEN_TO_TWENTY","TWENTY_ONE_OR_OLDER"],"type":"string"},"ageRanges":{"description":"Output only. The person's age ranges.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_AgeRangeType"}},"biographies":{"description":"The person's biographies. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Biography"}},"birthdays":{"description":"The person's birthdays. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Birthday"}},"braggingRights":{"description":"**DEPRECATED**: No data will be returned The person's bragging rights.","type":"array","items":{"$ref":"#/components/schemas/people_v1_BraggingRights"}},"calendarUrls":{"description":"The person's calendar URLs.","type":"array","items":{"$ref":"#/components/schemas/people_v1_CalendarUrl"}},"clientData":{"description":"The person's client data.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ClientData"}},"coverPhotos":{"description":"Output only. The person's cover photos.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_CoverPhoto"}},"emailAddresses":{"description":"The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.","type":"array","items":{"$ref":"#/components/schemas/people_v1_EmailAddress"}},"etag":{"description":"The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.","type":"string"},"events":{"description":"The person's events.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Event"}},"externalIds":{"description":"The person's external IDs.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ExternalId"}},"fileAses":{"description":"The person's file-ases.","type":"array","items":{"$ref":"#/components/schemas/people_v1_FileAs"}},"genders":{"description":"The person's genders. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Gender"}},"imClients":{"description":"The person's instant messaging clients.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ImClient"}},"interests":{"description":"The person's interests.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Interest"}},"locales":{"description":"The person's locale preferences.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Locale"}},"locations":{"description":"The person's locations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Location"}},"memberships":{"description":"The person's group memberships.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Membership"}},"metadata":{"$ref":"#/components/schemas/people_v1_PersonMetadata"},"miscKeywords":{"description":"The person's miscellaneous keywords.","type":"array","items":{"$ref":"#/components/schemas/people_v1_MiscKeyword"}},"names":{"description":"The person's names. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Name"}},"nicknames":{"description":"The person's nicknames.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Nickname"}},"occupations":{"description":"The person's occupations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Occupation"}},"organizations":{"description":"The person's past or current organizations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Organization"}},"phoneNumbers":{"description":"The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.","type":"array","items":{"$ref":"#/components/schemas/people_v1_PhoneNumber"}},"photos":{"description":"Output only. The person's photos.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_Photo"}},"relations":{"description":"The person's relations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Relation"}},"relationshipInterests":{"description":"Output only. **DEPRECATED**: No data will be returned The person's relationship interests.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_RelationshipInterest"}},"relationshipStatuses":{"description":"Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_RelationshipStatus"}},"residences":{"description":"**DEPRECATED**: (Please use `person.locations` instead) The person's residences.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Residence"}},"resourceName":{"description":"The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.","type":"string"},"sipAddresses":{"description":"The person's SIP addresses.","type":"array","items":{"$ref":"#/components/schemas/people_v1_SipAddress"}},"skills":{"description":"The person's skills.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Skill"}},"taglines":{"description":"Output only. **DEPRECATED**: No data will be returned The person's taglines.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_Tagline"}},"urls":{"description":"The person's associated URLs.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Url"}},"userDefined":{"description":"The person's user defined data.","type":"array","items":{"$ref":"#/components/schemas/people_v1_UserDefined"}}}},"people_v1_PersonMetadata":{"description":"The metadata about a person.","type":"object","properties":{"deleted":{"description":"Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.","readOnly":true,"type":"boolean"},"linkedPeopleResourceNames":{"description":"Output only. Resource names of people linked to this resource.","readOnly":true,"type":"array","items":{"type":"string"}},"objectType":{"description":"Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.","readOnly":true,"enum":["OBJECT_TYPE_UNSPECIFIED","PERSON","PAGE"],"type":"string"},"previousResourceNames":{"description":"Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.","readOnly":true,"type":"array","items":{"type":"string"}},"sources":{"description":"The sources of data for the person.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Source"}}}},"people_v1_PersonResponse":{"description":"The response for a single person","type":"object","properties":{"httpStatusCode":{"description":"**DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).","format":"int32","type":"integer"},"person":{"$ref":"#/components/schemas/people_v1_Person"},"requestedResourceName":{"description":"The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.","type":"string"},"status":{"$ref":"#/components/schemas/people_v1_Status"}}},"people_v1_PhoneNumber":{"description":"A person's phone number.","type":"object","properties":{"canonicalForm":{"description":"Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.","readOnly":true,"type":"string"},"formattedType":{"description":"Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`","type":"string"},"value":{"description":"The phone number.","type":"string"}}},"people_v1_Photo":{"description":"A person's photo. A picture shown next to the person's name to help others recognize the person.","type":"object","properties":{"default":{"description":"True if the photo is a default photo; false if the photo is a user-provided photo.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"url":{"description":"The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50","type":"string"}}},"people_v1_ProfileMetadata":{"description":"The metadata about a profile.","type":"object","properties":{"objectType":{"description":"Output only. The profile object type.","readOnly":true,"enum":["OBJECT_TYPE_UNSPECIFIED","PERSON","PAGE"],"type":"string"},"userTypes":{"description":"Output only. The user types.","readOnly":true,"type":"array","items":{"enum":["USER_TYPE_UNKNOWN","GOOGLE_USER","GPLUS_USER","GOOGLE_APPS_USER"],"type":"string"}}}},"people_v1_Relation":{"description":"A person's relation to another person.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"person":{"description":"The name of the other person this relation refers to.","type":"string"},"type":{"description":"The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`","type":"string"}}},"people_v1_RelationshipInterest":{"description":"**DEPRECATED**: No data will be returned A person's relationship interest .","type":"object","properties":{"formattedValue":{"description":"Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`","type":"string"}}},"people_v1_RelationshipStatus":{"description":"**DEPRECATED**: No data will be returned A person's relationship status.","type":"object","properties":{"formattedValue":{"description":"Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`","type":"string"}}},"people_v1_Residence":{"description":"**DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.","type":"object","properties":{"current":{"description":"True if the residence is the person's current residence; false if the residence is a past residence.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The address of the residence.","type":"string"}}},"people_v1_SearchDirectoryPeopleResponse":{"description":"The response to a request for people in the authenticated user's domain directory that match the specified query.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"people":{"description":"The list of people in the domain directory that match the query.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}},"totalSize":{"description":"The total number of items in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_SearchResponse":{"description":"The response to a search request for the authenticated user, given a query.","type":"object","properties":{"results":{"description":"The results of the request.","type":"array","items":{"$ref":"#/components/schemas/people_v1_SearchResult"}}}},"people_v1_SearchResult":{"description":"A result of a search query.","type":"object","properties":{"person":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_SipAddress":{"description":"A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`","type":"string"},"value":{"description":"The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.","type":"string"}}},"people_v1_Skill":{"description":"A skill that the person has.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The skill; for example, `underwater basket weaving`.","type":"string"}}},"people_v1_Source":{"description":"The source of a field.","type":"object","properties":{"etag":{"description":"**Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.","type":"string"},"id":{"description":"The unique identifier within the source type generated by the server.","type":"string"},"profileMetadata":{"$ref":"#/components/schemas/people_v1_ProfileMetadata"},"type":{"description":"The source type.","enum":["SOURCE_TYPE_UNSPECIFIED","ACCOUNT","PROFILE","DOMAIN_PROFILE","CONTACT","OTHER_CONTACT","DOMAIN_CONTACT"],"type":"string"},"updateTime":{"description":"Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.","format":"google-datetime","readOnly":true,"type":"string"}}},"people_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"people_v1_Tagline":{"description":"**DEPRECATED**: No data will be returned A brief one-line description of the person.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The tagline.","type":"string"}}},"people_v1_UpdateContactGroupRequest":{"description":"A request to update an existing user contact group. All updated fields will be replaced.","type":"object","properties":{"contactGroup":{"$ref":"#/components/schemas/people_v1_ContactGroup"},"readGroupFields":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"updateGroupFields":{"description":"Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name","format":"google-fieldmask","type":"string"}},"required":["contactGroup"]},"people_v1_UpdateContactPhotoRequest":{"description":"A request to update an existing contact's photo. All requests must have a valid photo format: JPEG or PNG.","type":"object","properties":{"personFields":{"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"photoBytes":{"description":"Required. Raw photo bytes","format":"byte","type":"string"},"sources":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}}},"required":["photoBytes"]},"people_v1_UpdateContactPhotoResponse":{"description":"The response for updating a contact's photo.","type":"object","properties":{"person":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_Url":{"description":"A person's associated URLs.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`","type":"string"},"value":{"description":"The URL.","type":"string"}}},"people_v1_UserDefined":{"description":"Arbitrary user data that is populated by the end users.","type":"object","properties":{"key":{"description":"The end user specified key of the user defined data.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The end user specified value of the user defined data.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/contacts":"","https://www.googleapis.com/auth/contacts.other.readonly":"","https://www.googleapis.com/auth/directory.readonly":"","https://www.googleapis.com/auth/user.addresses.read":"","https://www.googleapis.com/auth/user.birthday.read":"","https://www.googleapis.com/auth/user.emails.read":"","https://www.googleapis.com/auth/user.gender.read":"","https://www.googleapis.com/auth/user.organization.read":"","https://www.googleapis.com/auth/user.phonenumbers.read":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly","https://www.googleapis.com/auth/directory.readonly","https://www.googleapis.com/auth/user.addresses.read","https://www.googleapis.com/auth/user.birthday.read","https://www.googleapis.com/auth/user.emails.read","https://www.googleapis.com/auth/user.gender.read","https://www.googleapis.com/auth/user.organization.read","https://www.googleapis.com/auth/user.phonenumbers.read"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/people/v1/rest","service":"people","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"People API","version":"v1","description":"Provides access to information about profiles and contacts."},"servers":[{"url":"https://people.googleapis.com/"}],"paths":{"/v1/contactGroups":{"get":{"operationId":"people.contactGroups.list","x-executor-toolPath":"people.contactGroups.list","tags":["People API"],"description":"List all contact groups owned by the authenticated user. Members of the contact groups are not populated.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"groupFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","schema":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.","schema":{"description":"Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.","schema":{"description":"Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.","schema":{"description":"Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListContactGroupsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.readonly","https://www.googleapis.com/auth/contacts"]},"post":{"operationId":"people.contactGroups.create","x-executor-toolPath":"people.contactGroups.create","tags":["People API"],"description":"Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_CreateContactGroupRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ContactGroup"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/contactGroups/{contactGroupsId}":{"get":{"operationId":"people.contactGroups.get","x-executor-toolPath":"people.contactGroups.get","tags":["People API"],"description":"Get a specific contact group owned by the authenticated user by specifying a contact group resource name.","parameters":[{"name":"contactGroupsId","in":"path","required":true,"description":"`contactGroupsId` of `resourceName` (`contactGroups/{contactGroupsId}`). Required. The resource name of the contact group to get.","schema":{"description":"`contactGroupsId` of `resourceName` (`contactGroups/{contactGroupsId}`). Required. The resource name of the contact group to get.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"groupFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","schema":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxMembers","in":"query","required":false,"description":"Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.","schema":{"description":"Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ContactGroup"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.readonly","https://www.googleapis.com/auth/contacts"]}},"/v1/contactGroups:batchGet":{"get":{"operationId":"people.contactGroups.batchGet","x-executor-toolPath":"people.contactGroups.batchGet","tags":["People API"],"description":"Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"groupFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","schema":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxMembers","in":"query","required":false,"description":"Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.","schema":{"description":"Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"resourceNames","in":"query","required":true,"description":"Required. The resource names of the contact groups to get. There is a maximum of 200 resource names.","schema":{"type":"array","items":{"description":"Required. The resource names of the contact groups to get. There is a maximum of 200 resource names.","type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchGetContactGroupsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.readonly","https://www.googleapis.com/auth/contacts"]}},"/v1/otherContacts":{"get":{"operationId":"people.otherContacts.list","x-executor-toolPath":"people.otherContacts.list","tags":["People API"],"description":"List all \"Other contacts\", that is contacts that are not in a contact group. \"Other contacts\" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an [google.rpc.ErrorInfo](https://cloud.google.com/apis/design/errors#error_info) with reason \"EXPIRED_SYNC_TOKEN\". In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of \"Other contacts\" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of \"Other contacts\" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"requestSyncToken","in":"query","required":false,"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.","schema":{"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.","type":"boolean"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.","schema":{"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListOtherContactsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.other.readonly"]}},"/v1/otherContacts:search":{"get":{"operationId":"people.otherContacts.search","x-executor-toolPath":"people.otherContacts.search","tags":["People API"],"description":"Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","schema":{"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":true,"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","schema":{"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_SearchResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.other.readonly"]}},"/v1/people/{peopleId}":{"get":{"operationId":"people.people.get","x-executor-toolPath":"people.people.get","tags":["People API"],"description":"Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.","parameters":[{"name":"peopleId","in":"path","required":true,"description":"`peopleId` of `resourceName` (`people/{peopleId}`). Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.","schema":{"description":"`peopleId` of `resourceName` (`people/{peopleId}`). Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestMask.includeField","in":"query","required":false,"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","schema":{"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/userinfo.email"]},{"googleOAuth2":["https://www.googleapis.com/auth/userinfo.profile"]},{"googleOAuth2":["openid"]},{"googleOAuth2":["email"]},{"googleOAuth2":["profile"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.addresses.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.birthday.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.emails.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.gender.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.organization.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.phonenumbers.read"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.readonly","https://www.googleapis.com/auth/userinfo.email","https://www.googleapis.com/auth/userinfo.profile","openid","email","profile","https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly","https://www.googleapis.com/auth/directory.readonly","https://www.googleapis.com/auth/user.addresses.read","https://www.googleapis.com/auth/user.birthday.read","https://www.googleapis.com/auth/user.emails.read","https://www.googleapis.com/auth/user.gender.read","https://www.googleapis.com/auth/user.organization.read","https://www.googleapis.com/auth/user.phonenumbers.read"]}},"/v1/people:batchCreateContacts":{"post":{"operationId":"people.people.batchCreateContacts","x-executor-toolPath":"people.people.batchCreateContacts","tags":["People API"],"description":"Create a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchCreateContactsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchCreateContactsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:batchDeleteContacts":{"post":{"operationId":"people.people.batchDeleteContacts","x-executor-toolPath":"people.people.batchDeleteContacts","tags":["People API"],"description":"Delete a batch of contacts. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchDeleteContactsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:batchGet":{"get":{"operationId":"people.people.getBatchGet","x-executor-toolPath":"people.people.getBatchGet","tags":["People API"],"description":"Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestMask.includeField","in":"query","required":false,"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","schema":{"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"resourceNames","in":"query","required":true,"description":"Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&resourceNames=&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. There is a maximum of 200 resource names.","schema":{"type":"array","items":{"description":"Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&resourceNames=&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. There is a maximum of 200 resource names.","type":"string"}},"style":"form","explode":true},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_GetPeopleResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/userinfo.email"]},{"googleOAuth2":["https://www.googleapis.com/auth/userinfo.profile"]},{"googleOAuth2":["openid"]},{"googleOAuth2":["email"]},{"googleOAuth2":["profile"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.addresses.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.birthday.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.emails.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.gender.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.organization.read"]},{"googleOAuth2":["https://www.googleapis.com/auth/user.phonenumbers.read"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.readonly","https://www.googleapis.com/auth/userinfo.email","https://www.googleapis.com/auth/userinfo.profile","openid","email","profile","https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly","https://www.googleapis.com/auth/directory.readonly","https://www.googleapis.com/auth/user.addresses.read","https://www.googleapis.com/auth/user.birthday.read","https://www.googleapis.com/auth/user.emails.read","https://www.googleapis.com/auth/user.gender.read","https://www.googleapis.com/auth/user.organization.read","https://www.googleapis.com/auth/user.phonenumbers.read"]}},"/v1/people:batchUpdateContacts":{"post":{"operationId":"people.people.batchUpdateContacts","x-executor-toolPath":"people.people.batchUpdateContacts","tags":["People API"],"description":"Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchUpdateContactsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_BatchUpdateContactsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:createContact":{"post":{"operationId":"people.people.createContact","x-executor-toolPath":"people.people.createContact","tags":["People API"],"description":"Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/people:listDirectoryPeople":{"get":{"operationId":"people.people.listDirectoryPeople","x-executor-toolPath":"people.people.listDirectoryPeople","tags":["People API"],"description":"Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directory_people_that_have_changed).","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mergeSources","in":"query","required":false,"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","schema":{"type":"array","items":{"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","enum":["DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_MERGE_SOURCE_TYPE_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"requestSyncToken","in":"query","required":false,"description":"Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.","schema":{"description":"Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.","type":"boolean"},"style":"form","explode":false},{"name":"sources","in":"query","required":true,"description":"Required. Directory sources to return.","schema":{"type":"array","items":{"description":"Required. Directory sources to return.","enum":["DIRECTORY_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT","DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE"],"type":"string"}},"style":"form","explode":true},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.","schema":{"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListDirectoryPeopleResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/directory.readonly"]}},"/v1/people:searchContacts":{"get":{"operationId":"people.people.searchContacts","x-executor-toolPath":"people.people.searchContacts","tags":["People API"],"description":"Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","schema":{"description":"Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":true,"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","schema":{"description":"Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_SearchResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.readonly","https://www.googleapis.com/auth/contacts"]}},"/v1/people:searchDirectoryPeople":{"get":{"operationId":"people.people.searchDirectoryPeople","x-executor-toolPath":"people.people.searchDirectoryPeople","tags":["People API"],"description":"Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mergeSources","in":"query","required":false,"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","schema":{"type":"array","items":{"description":"Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.","enum":["DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_MERGE_SOURCE_TYPE_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"query","in":"query","required":true,"description":"Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.","schema":{"description":"Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"readMask","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":true,"description":"Required. Directory sources to return.","schema":{"type":"array","items":{"description":"Required. Directory sources to return.","enum":["DIRECTORY_SOURCE_TYPE_UNSPECIFIED","DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT","DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_SearchDirectoryPeopleResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/directory.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/directory.readonly"]}},"/v1/{resourceName}":{"put":{"operationId":"people.contactGroups.update","x-executor-toolPath":"people.contactGroups.update","tags":["People API"],"description":"Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.","schema":{"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_UpdateContactGroupRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ContactGroup"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]},"delete":{"operationId":"people.contactGroups.delete","x-executor-toolPath":"people.contactGroups.delete","tags":["People API"],"description":"Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact group to delete.","schema":{"description":"Required. The resource name of the contact group to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"deleteContacts","in":"query","required":false,"description":"Optional. Set to true to also delete the contacts in the specified group.","schema":{"description":"Optional. Set to true to also delete the contacts in the specified group.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}/connections":{"get":{"operationId":"people.people.connections.list","x-executor-toolPath":"people.people.connections.list","tags":["People API"],"description":"Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an [google.rpc.ErrorInfo](https://cloud.google.com/apis/design/errors#error_info) with reason \"EXPIRED_SYNC_TOKEN\". In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's contacts that have changed](/people/v1/contacts#list_the_users_contacts_that_have_changed).","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name to return connections for. Only `people/me` is valid.","schema":{"description":"Required. The resource name to return connections for. Only `people/me` is valid.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","schema":{"description":"Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token.","schema":{"description":"Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"requestMask.includeField","in":"query","required":false,"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","schema":{"description":"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"requestSyncToken","in":"query","required":false,"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.","schema":{"description":"Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.","type":"boolean"},"style":"form","explode":false},{"name":"sortOrder","in":"query","required":false,"description":"Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.","schema":{"description":"Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.","enum":["LAST_MODIFIED_ASCENDING","LAST_MODIFIED_DESCENDING","FIRST_NAME_ASCENDING","LAST_NAME_ASCENDING"],"type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"syncToken","in":"query","required":false,"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.","schema":{"description":"Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ListConnectionsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts.readonly","https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}/members:modify":{"post":{"operationId":"people.contactGroups.members.modify","x-executor-toolPath":"people.contactGroups.members.modify","tags":["People API"],"description":"Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact group to modify.","schema":{"description":"Required. The resource name of the contact group to modify.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ModifyContactGroupMembersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_ModifyContactGroupMembersResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:copyOtherContactToMyContactsGroup":{"post":{"operationId":"people.otherContacts.copyOtherContactToMyContactsGroup","x-executor-toolPath":"people.otherContacts.copyOtherContactToMyContactsGroup","tags":["People API"],"description":"Copies an \"Other contact\" to a new contact in the user's \"myContacts\" group Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the \"Other contact\" to copy.","schema":{"description":"Required. The resource name of the \"Other contact\" to copy.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_CopyOtherContactToMyContactsGroupRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]},{"googleOAuth2":["https://www.googleapis.com/auth/contacts.other.readonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly"]}},"/v1/{resourceName}:deleteContact":{"delete":{"operationId":"people.people.deleteContact","x-executor-toolPath":"people.people.deleteContact","tags":["People API"],"description":"Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact to delete.","schema":{"description":"Required. The resource name of the contact to delete.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Empty"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:deleteContactPhoto":{"delete":{"operationId":"people.people.deleteContactPhoto","x-executor-toolPath":"people.people.deleteContactPhoto","tags":["People API"],"description":"Delete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. The resource name of the contact whose photo will be deleted.","schema":{"description":"Required. The resource name of the contact whose photo will be deleted.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_DeleteContactPhotoResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:updateContact":{"patch":{"operationId":"people.people.updateContact","x-executor-toolPath":"people.people.updateContact","tags":["People API"],"description":"Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `\"failedPrecondition\"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. If making sequential updates to the same person, the etag from the `updateContact` response should be used to avoid failures. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.","schema":{"description":"The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"personFields","in":"query","required":false,"description":"Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","schema":{"description":"Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sources","in":"query","required":false,"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","schema":{"type":"array","items":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"style":"form","explode":true},{"name":"updatePersonFields","in":"query","required":true,"description":"Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined","schema":{"description":"Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_Person"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}},"/v1/{resourceName}:updateContactPhoto":{"patch":{"operationId":"people.people.updateContactPhoto","x-executor-toolPath":"people.people.updateContactPhoto","tags":["People API"],"description":"Update a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.","parameters":[{"name":"resourceName","in":"path","required":true,"description":"Required. Person resource name","schema":{"description":"Required. Person resource name","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_UpdateContactPhotoRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_v1_UpdateContactPhotoResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/contacts"]}],"x-google-scopes":["https://www.googleapis.com/auth/contacts"]}}},"components":{"schemas":{"people_v1_Address":{"description":"A person's physical address. May be a P.O. box or street address. All fields are optional.","type":"object","properties":{"city":{"description":"The city of the address.","type":"string"},"country":{"description":"The country of the address.","type":"string"},"countryCode":{"description":"The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.","type":"string"},"extendedAddress":{"description":"The extended address of the address; for example, the apartment number.","type":"string"},"formattedType":{"description":"Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"formattedValue":{"description":"The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"poBox":{"description":"The P.O. box of the address.","type":"string"},"postalCode":{"description":"The postal code of the address.","type":"string"},"region":{"description":"The region of the address; for example, the state or province.","type":"string"},"streetAddress":{"description":"The street address.","type":"string"},"type":{"description":"The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`","type":"string"}}},"people_v1_AgeRangeType":{"description":"A person's age range.","type":"object","properties":{"ageRange":{"description":"The age range.","enum":["AGE_RANGE_UNSPECIFIED","LESS_THAN_EIGHTEEN","EIGHTEEN_TO_TWENTY","TWENTY_ONE_OR_OLDER"],"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"}}},"people_v1_BatchCreateContactsRequest":{"description":"A request to create a batch of contacts.","type":"object","properties":{"contacts":{"description":"Required. The contact to create. Allows up to 200 contacts in a single request.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ContactToCreate"}},"readMask":{"description":"Required. A field mask to restrict which fields on each person are returned in the response. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"sources":{"description":"Optional. A mask of what source types to return in the post mutate read. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}}},"required":["contacts","readMask"]},"people_v1_BatchCreateContactsResponse":{"description":"If not successful, returns BatchCreateContactsErrorDetails which contains a list of errors for each invalid contact. The response to a request to create a batch of contacts.","type":"object","properties":{"createdPeople":{"description":"The contacts that were created, unless the request `read_mask` is empty.","type":"array","items":{"$ref":"#/components/schemas/people_v1_PersonResponse"}}}},"people_v1_BatchDeleteContactsRequest":{"description":"A request to delete a batch of existing contacts.","type":"object","properties":{"resourceNames":{"description":"Required. The resource names of the contact to delete. It's repeatable. Allows up to 500 resource names in a single request.","type":"array","items":{"type":"string"}}},"required":["resourceNames"]},"people_v1_BatchGetContactGroupsResponse":{"description":"The response to a batch get contact groups request.","type":"object","properties":{"responses":{"description":"The list of responses for each requested contact group resource.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ContactGroupResponse"}}}},"people_v1_BatchUpdateContactsRequest":{"description":"A request to update a batch of contacts.","type":"object","properties":{"contacts":{"description":"Required. A map of resource names to the person data to be updated. Allows up to 200 contacts in a single request.","type":"object","additionalProperties":{"$ref":"#/components/schemas/people_v1_Person"}},"readMask":{"description":"Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"sources":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}},"updateMask":{"description":"Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All specified fields will be replaced, or cleared if left empty for each person. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined","format":"google-fieldmask","type":"string"}},"required":["contacts","updateMask","readMask"]},"people_v1_BatchUpdateContactsResponse":{"description":"If not successful, returns BatchUpdateContactsErrorDetails, a list of errors corresponding to each contact. The response to a request to update a batch of contacts.","type":"object","properties":{"updateResult":{"description":"A map of resource names to the contacts that were updated, unless the request `read_mask` is empty.","type":"object","additionalProperties":{"$ref":"#/components/schemas/people_v1_PersonResponse"}}}},"people_v1_Biography":{"description":"A person's short biography.","type":"object","properties":{"contentType":{"description":"The content type of the biography.","enum":["CONTENT_TYPE_UNSPECIFIED","TEXT_PLAIN","TEXT_HTML"],"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The short biography.","type":"string"}}},"people_v1_Birthday":{"description":"A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to. Clients should always set the `date` field when mutating birthdays.","type":"object","properties":{"date":{"$ref":"#/components/schemas/people_v1_Date"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"text":{"description":"Prefer to use the `date` field if set. A free-form string representing the user's birthday. This value is not validated.","type":"string"}}},"people_v1_BraggingRights":{"description":"**DEPRECATED**: No data will be returned A person's bragging rights.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The bragging rights; for example, `climbed mount everest`.","type":"string"}}},"people_v1_CalendarUrl":{"description":"A person's calendar URL.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`","type":"string"},"url":{"description":"The calendar URL.","type":"string"}}},"people_v1_ClientData":{"description":"Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.","type":"object","properties":{"key":{"description":"The client specified key of the client data.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The client specified value of the client data.","type":"string"}}},"people_v1_ContactGroup":{"description":"A contact group.","type":"object","properties":{"clientData":{"description":"The group's client data.","type":"array","items":{"$ref":"#/components/schemas/people_v1_GroupClientData"}},"etag":{"description":"The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.","type":"string"},"formattedName":{"description":"Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.","readOnly":true,"type":"string"},"groupType":{"description":"Output only. The contact group type.","readOnly":true,"enum":["GROUP_TYPE_UNSPECIFIED","USER_CONTACT_GROUP","SYSTEM_CONTACT_GROUP"],"type":"string"},"memberCount":{"description":"Output only. The total number of contacts in the group irrespective of max members in specified in the request.","format":"int32","readOnly":true,"type":"integer"},"memberResourceNames":{"description":"Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.","readOnly":true,"type":"array","items":{"type":"string"}},"metadata":{"$ref":"#/components/schemas/people_v1_ContactGroupMetadata"},"name":{"description":"The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.","type":"string"},"resourceName":{"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.","type":"string"}}},"people_v1_ContactGroupMembership":{"description":"A Google contact group membership.","type":"object","properties":{"contactGroupId":{"description":"Output only. The contact group ID for the contact group membership.","readOnly":true,"type":"string"},"contactGroupResourceName":{"description":"The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or \"myContacts\" or \"starred\" system groups memberships can be added. A contact must always have at least one contact group membership.","type":"string"}}},"people_v1_ContactGroupMetadata":{"description":"The metadata about a contact group.","type":"object","properties":{"deleted":{"description":"Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.","readOnly":true,"type":"boolean"},"updateTime":{"description":"Output only. The time the group was last updated.","format":"google-datetime","readOnly":true,"type":"string"}}},"people_v1_ContactGroupResponse":{"description":"The response for a specific contact group.","type":"object","properties":{"contactGroup":{"$ref":"#/components/schemas/people_v1_ContactGroup"},"requestedResourceName":{"description":"The original requested resource name.","type":"string"},"status":{"$ref":"#/components/schemas/people_v1_Status"}}},"people_v1_ContactToCreate":{"description":"A wrapper that contains the person data to populate a newly created source.","type":"object","properties":{"contactPerson":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_CopyOtherContactToMyContactsGroupRequest":{"description":"A request to copy an \"Other contact\" to my contacts group.","type":"object","properties":{"copyMask":{"description":"Required. A field mask to restrict which fields are copied into the new contact. Valid values are: * emailAddresses * names * phoneNumbers","format":"google-fieldmask","type":"string"},"readMask":{"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"sources":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}}},"required":["copyMask"]},"people_v1_CoverPhoto":{"description":"A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.","type":"object","properties":{"default":{"description":"True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"url":{"description":"The URL of the cover photo.","type":"string"}}},"people_v1_CreateContactGroupRequest":{"description":"A request to create a new contact group.","type":"object","properties":{"contactGroup":{"$ref":"#/components/schemas/people_v1_ContactGroup"},"readGroupFields":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name","format":"google-fieldmask","type":"string"}},"required":["contactGroup"]},"people_v1_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":{"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.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"people_v1_DeleteContactPhotoResponse":{"description":"The response for deleting a contact's photo.","type":"object","properties":{"person":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_DomainMembership":{"description":"A Google Workspace Domain membership.","type":"object","properties":{"inViewerDomain":{"description":"True if the person is in the viewer's Google Workspace domain.","type":"boolean"}}},"people_v1_EmailAddress":{"description":"A person's email address.","type":"object","properties":{"displayName":{"description":"The display name of the email.","type":"string"},"formattedType":{"description":"Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`","type":"string"},"value":{"description":"The email address.","type":"string"}}},"people_v1_Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","type":"object"},"people_v1_Event":{"description":"An event related to the person.","type":"object","properties":{"date":{"$ref":"#/components/schemas/people_v1_Date"},"formattedType":{"description":"Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`","type":"string"}}},"people_v1_ExternalId":{"description":"An identifier from an external entity related to the person.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`","type":"string"},"value":{"description":"The value of the external ID.","type":"string"}}},"people_v1_FieldMetadata":{"description":"Metadata about a field.","type":"object","properties":{"primary":{"description":"Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.","readOnly":true,"type":"boolean"},"source":{"$ref":"#/components/schemas/people_v1_Source"},"sourcePrimary":{"description":"True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.","type":"boolean"},"verified":{"description":"Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.","readOnly":true,"type":"boolean"}}},"people_v1_FileAs":{"description":"The name that should be used to sort the person in a list.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The file-as value","type":"string"}}},"people_v1_Gender":{"description":"A person's gender.","type":"object","properties":{"addressMeAs":{"description":"Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`","type":"string"},"formattedValue":{"description":"Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`","type":"string"}}},"people_v1_GetPeopleResponse":{"description":"The response to a get request for a list of people by resource name.","type":"object","properties":{"responses":{"description":"The response for each requested resource name.","type":"array","items":{"$ref":"#/components/schemas/people_v1_PersonResponse"}}}},"people_v1_GroupClientData":{"description":"Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.","type":"object","properties":{"key":{"description":"The client specified key of the client data.","type":"string"},"value":{"description":"The client specified value of the client data.","type":"string"}}},"people_v1_ImClient":{"description":"A person's instant messaging client.","type":"object","properties":{"formattedProtocol":{"description":"Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"formattedType":{"description":"Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"protocol":{"description":"The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`","type":"string"},"type":{"description":"The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`","type":"string"},"username":{"description":"The user name used in the IM client.","type":"string"}}},"people_v1_Interest":{"description":"One of the person's interests.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The interest; for example, `stargazing`.","type":"string"}}},"people_v1_ListConnectionsResponse":{"description":"The response to a request for the authenticated user's connections.","type":"object","properties":{"connections":{"description":"The list of people that the requestor is connected to.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}},"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"nextSyncToken":{"description":"A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token. When the response is paginated, only the last page will contain `nextSyncToken`.","type":"string"},"totalItems":{"description":"The total number of items in the list without pagination.","format":"int32","type":"integer"},"totalPeople":{"description":"**DEPRECATED** (Please use totalItems) The total number of people in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_ListContactGroupsResponse":{"description":"The response to a list contact groups request.","type":"object","properties":{"contactGroups":{"description":"The list of contact groups. Members of the contact groups are not populated.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ContactGroup"}},"nextPageToken":{"description":"The token that can be used to retrieve the next page of results.","type":"string"},"nextSyncToken":{"description":"The token that can be used to retrieve changes since the last request.","type":"string"},"totalItems":{"description":"The total number of items in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_ListDirectoryPeopleResponse":{"description":"The response to a request for the authenticated user's domain directory.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"nextSyncToken":{"description":"A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.","type":"string"},"people":{"description":"The list of people in the domain directory.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}}}},"people_v1_ListOtherContactsResponse":{"description":"The response to a request for the authenticated user's \"Other contacts\".","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"nextSyncToken":{"description":"A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.","type":"string"},"otherContacts":{"description":"The list of \"Other contacts\" returned as Person resources. \"Other contacts\" support a limited subset of fields. See ListOtherContactsRequest.request_mask for more detailed information.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}},"totalSize":{"description":"The total number of other contacts in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_Locale":{"description":"A person's locale preference.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.","type":"string"}}},"people_v1_Location":{"description":"A person's location.","type":"object","properties":{"buildingId":{"description":"The building identifier.","type":"string"},"current":{"description":"Whether the location is the current location.","type":"boolean"},"deskCode":{"description":"The individual desk location.","type":"string"},"floor":{"description":"The floor name or number.","type":"string"},"floorSection":{"description":"The floor section in `floor_name`.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`","type":"string"},"value":{"description":"The free-form value of the location.","type":"string"}}},"people_v1_Membership":{"description":"A person's membership in a group. Only contact group memberships can be modified.","type":"object","properties":{"contactGroupMembership":{"$ref":"#/components/schemas/people_v1_ContactGroupMembership"},"domainMembership":{"$ref":"#/components/schemas/people_v1_DomainMembership"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"}}},"people_v1_MiscKeyword":{"description":"A person's miscellaneous keyword.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The miscellaneous keyword type.","enum":["TYPE_UNSPECIFIED","OUTLOOK_BILLING_INFORMATION","OUTLOOK_DIRECTORY_SERVER","OUTLOOK_KEYWORD","OUTLOOK_MILEAGE","OUTLOOK_PRIORITY","OUTLOOK_SENSITIVITY","OUTLOOK_SUBJECT","OUTLOOK_USER","HOME","WORK","OTHER"],"type":"string"},"value":{"description":"The value of the miscellaneous keyword.","type":"string"}}},"people_v1_ModifyContactGroupMembersRequest":{"description":"A request to modify an existing contact group's members. Contacts can be removed from any group but they can only be added to a user group or \"myContacts\" or \"starred\" system groups.","type":"object","properties":{"resourceNamesToAdd":{"description":"Optional. The resource names of the contact people to add in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.","type":"array","items":{"type":"string"}},"resourceNamesToRemove":{"description":"Optional. The resource names of the contact people to remove in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.","type":"array","items":{"type":"string"}}}},"people_v1_ModifyContactGroupMembersResponse":{"description":"The response to a modify contact group members request.","type":"object","properties":{"canNotRemoveLastContactGroupResourceNames":{"description":"The contact people resource names that cannot be removed from their last contact group.","type":"array","items":{"type":"string"}},"notFoundResourceNames":{"description":"The contact people resource names that were not found.","type":"array","items":{"type":"string"}}}},"people_v1_Name":{"description":"A person's name. If the name is a mononym, the family name is empty.","type":"object","properties":{"displayName":{"description":"Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.","readOnly":true,"type":"string"},"displayNameLastFirst":{"description":"Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.","readOnly":true,"type":"string"},"familyName":{"description":"The family name.","type":"string"},"givenName":{"description":"The given name.","type":"string"},"honorificPrefix":{"description":"The honorific prefixes, such as `Mrs.` or `Dr.`","type":"string"},"honorificSuffix":{"description":"The honorific suffixes, such as `Jr.`","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"middleName":{"description":"The middle name(s).","type":"string"},"phoneticFamilyName":{"description":"The family name spelled as it sounds.","type":"string"},"phoneticFullName":{"description":"The full name spelled as it sounds.","type":"string"},"phoneticGivenName":{"description":"The given name spelled as it sounds.","type":"string"},"phoneticHonorificPrefix":{"description":"The honorific prefixes spelled as they sound.","type":"string"},"phoneticHonorificSuffix":{"description":"The honorific suffixes spelled as they sound.","type":"string"},"phoneticMiddleName":{"description":"The middle name(s) spelled as they sound.","type":"string"},"unstructuredName":{"description":"The free form name value.","type":"string"}}},"people_v1_Nickname":{"description":"A person's nickname.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the nickname.","enum":["DEFAULT","MAIDEN_NAME","INITIALS","GPLUS","OTHER_NAME","ALTERNATE_NAME","SHORT_NAME"],"type":"string"},"value":{"description":"The nickname.","type":"string"}}},"people_v1_Occupation":{"description":"A person's occupation.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The occupation; for example, `carpenter`.","type":"string"}}},"people_v1_Organization":{"description":"A person's past or current organization. Overlapping date ranges are permitted.","type":"object","properties":{"costCenter":{"description":"The person's cost center at the organization.","type":"string"},"current":{"description":"True if the organization is the person's current organization; false if the organization is a past organization.","type":"boolean"},"department":{"description":"The person's department at the organization.","type":"string"},"domain":{"description":"The domain name associated with the organization; for example, `google.com`.","type":"string"},"endDate":{"$ref":"#/components/schemas/people_v1_Date"},"formattedType":{"description":"Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"fullTimeEquivalentMillipercent":{"description":"The person's full-time equivalent millipercent within the organization (100000 = 100%).","format":"int32","type":"integer"},"jobDescription":{"description":"The person's job description at the organization.","type":"string"},"location":{"description":"The location of the organization office the person works at.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"name":{"description":"The name of the organization.","type":"string"},"phoneticName":{"description":"The phonetic name of the organization.","type":"string"},"startDate":{"$ref":"#/components/schemas/people_v1_Date"},"symbol":{"description":"The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.","type":"string"},"title":{"description":"The person's job title at the organization.","type":"string"},"type":{"description":"The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`","type":"string"}}},"people_v1_Person":{"description":"Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.","type":"object","properties":{"addresses":{"description":"The person's street addresses.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Address"}},"ageRange":{"description":"Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.","readOnly":true,"enum":["AGE_RANGE_UNSPECIFIED","LESS_THAN_EIGHTEEN","EIGHTEEN_TO_TWENTY","TWENTY_ONE_OR_OLDER"],"type":"string"},"ageRanges":{"description":"Output only. The person's age ranges.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_AgeRangeType"}},"biographies":{"description":"The person's biographies. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Biography"}},"birthdays":{"description":"The person's birthdays. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Birthday"}},"braggingRights":{"description":"**DEPRECATED**: No data will be returned The person's bragging rights.","type":"array","items":{"$ref":"#/components/schemas/people_v1_BraggingRights"}},"calendarUrls":{"description":"The person's calendar URLs.","type":"array","items":{"$ref":"#/components/schemas/people_v1_CalendarUrl"}},"clientData":{"description":"The person's client data.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ClientData"}},"coverPhotos":{"description":"Output only. The person's cover photos.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_CoverPhoto"}},"emailAddresses":{"description":"The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.","type":"array","items":{"$ref":"#/components/schemas/people_v1_EmailAddress"}},"etag":{"description":"The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.","type":"string"},"events":{"description":"The person's events.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Event"}},"externalIds":{"description":"The person's external IDs.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ExternalId"}},"fileAses":{"description":"The person's file-ases.","type":"array","items":{"$ref":"#/components/schemas/people_v1_FileAs"}},"genders":{"description":"The person's genders. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Gender"}},"imClients":{"description":"The person's instant messaging clients.","type":"array","items":{"$ref":"#/components/schemas/people_v1_ImClient"}},"interests":{"description":"The person's interests.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Interest"}},"locales":{"description":"The person's locale preferences.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Locale"}},"locations":{"description":"The person's locations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Location"}},"memberships":{"description":"The person's group memberships.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Membership"}},"metadata":{"$ref":"#/components/schemas/people_v1_PersonMetadata"},"miscKeywords":{"description":"The person's miscellaneous keywords.","type":"array","items":{"$ref":"#/components/schemas/people_v1_MiscKeyword"}},"names":{"description":"The person's names. This field is a singleton for contact sources.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Name"}},"nicknames":{"description":"The person's nicknames.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Nickname"}},"occupations":{"description":"The person's occupations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Occupation"}},"organizations":{"description":"The person's past or current organizations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Organization"}},"phoneNumbers":{"description":"The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.","type":"array","items":{"$ref":"#/components/schemas/people_v1_PhoneNumber"}},"photos":{"description":"Output only. The person's photos.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_Photo"}},"relations":{"description":"The person's relations.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Relation"}},"relationshipInterests":{"description":"Output only. **DEPRECATED**: No data will be returned The person's relationship interests.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_RelationshipInterest"}},"relationshipStatuses":{"description":"Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_RelationshipStatus"}},"residences":{"description":"**DEPRECATED**: (Please use `person.locations` instead) The person's residences.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Residence"}},"resourceName":{"description":"The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.","type":"string"},"sipAddresses":{"description":"The person's SIP addresses.","type":"array","items":{"$ref":"#/components/schemas/people_v1_SipAddress"}},"skills":{"description":"The person's skills.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Skill"}},"taglines":{"description":"Output only. **DEPRECATED**: No data will be returned The person's taglines.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/people_v1_Tagline"}},"urls":{"description":"The person's associated URLs.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Url"}},"userDefined":{"description":"The person's user defined data.","type":"array","items":{"$ref":"#/components/schemas/people_v1_UserDefined"}}}},"people_v1_PersonMetadata":{"description":"The metadata about a person.","type":"object","properties":{"deleted":{"description":"Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.","readOnly":true,"type":"boolean"},"linkedPeopleResourceNames":{"description":"Output only. Resource names of people linked to this resource.","readOnly":true,"type":"array","items":{"type":"string"}},"objectType":{"description":"Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.","readOnly":true,"enum":["OBJECT_TYPE_UNSPECIFIED","PERSON","PAGE"],"type":"string"},"previousResourceNames":{"description":"Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.","readOnly":true,"type":"array","items":{"type":"string"}},"sources":{"description":"The sources of data for the person.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Source"}}}},"people_v1_PersonResponse":{"description":"The response for a single person","type":"object","properties":{"httpStatusCode":{"description":"**DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).","format":"int32","type":"integer"},"person":{"$ref":"#/components/schemas/people_v1_Person"},"requestedResourceName":{"description":"The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.","type":"string"},"status":{"$ref":"#/components/schemas/people_v1_Status"}}},"people_v1_PhoneNumber":{"description":"A person's phone number.","type":"object","properties":{"canonicalForm":{"description":"Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.","readOnly":true,"type":"string"},"formattedType":{"description":"Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`","type":"string"},"value":{"description":"The phone number.","type":"string"}}},"people_v1_Photo":{"description":"A person's photo. A picture shown next to the person's name to help others recognize the person.","type":"object","properties":{"default":{"description":"True if the photo is a default photo; false if the photo is a user-provided photo.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"url":{"description":"The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50","type":"string"}}},"people_v1_ProfileMetadata":{"description":"The metadata about a profile.","type":"object","properties":{"objectType":{"description":"Output only. The profile object type.","readOnly":true,"enum":["OBJECT_TYPE_UNSPECIFIED","PERSON","PAGE"],"type":"string"},"userTypes":{"description":"Output only. The user types.","readOnly":true,"type":"array","items":{"enum":["USER_TYPE_UNKNOWN","GOOGLE_USER","GPLUS_USER","GOOGLE_APPS_USER"],"type":"string"}}}},"people_v1_Relation":{"description":"A person's relation to another person.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"person":{"description":"The name of the other person this relation refers to.","type":"string"},"type":{"description":"The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`","type":"string"}}},"people_v1_RelationshipInterest":{"description":"**DEPRECATED**: No data will be returned A person's relationship interest .","type":"object","properties":{"formattedValue":{"description":"Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`","type":"string"}}},"people_v1_RelationshipStatus":{"description":"**DEPRECATED**: No data will be returned A person's relationship status.","type":"object","properties":{"formattedValue":{"description":"Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`","type":"string"}}},"people_v1_Residence":{"description":"**DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.","type":"object","properties":{"current":{"description":"True if the residence is the person's current residence; false if the residence is a past residence.","type":"boolean"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The address of the residence.","type":"string"}}},"people_v1_SearchDirectoryPeopleResponse":{"description":"The response to a request for people in the authenticated user's domain directory that match the specified query.","type":"object","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"people":{"description":"The list of people in the domain directory that match the query.","type":"array","items":{"$ref":"#/components/schemas/people_v1_Person"}},"totalSize":{"description":"The total number of items in the list without pagination.","format":"int32","type":"integer"}}},"people_v1_SearchResponse":{"description":"The response to a search request for the authenticated user, given a query.","type":"object","properties":{"results":{"description":"The results of the request.","type":"array","items":{"$ref":"#/components/schemas/people_v1_SearchResult"}}}},"people_v1_SearchResult":{"description":"A result of a search query.","type":"object","properties":{"person":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_SipAddress":{"description":"A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`","type":"string"},"value":{"description":"The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.","type":"string"}}},"people_v1_Skill":{"description":"A skill that the person has.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The skill; for example, `underwater basket weaving`.","type":"string"}}},"people_v1_Source":{"description":"The source of a field.","type":"object","properties":{"etag":{"description":"**Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.","type":"string"},"id":{"description":"The unique identifier within the source type generated by the server.","type":"string"},"profileMetadata":{"$ref":"#/components/schemas/people_v1_ProfileMetadata"},"type":{"description":"The source type.","enum":["SOURCE_TYPE_UNSPECIFIED","ACCOUNT","PROFILE","DOMAIN_PROFILE","CONTACT","OTHER_CONTACT","DOMAIN_CONTACT"],"type":"string"},"updateTime":{"description":"Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.","format":"google-datetime","readOnly":true,"type":"string"}}},"people_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"people_v1_Tagline":{"description":"**DEPRECATED**: No data will be returned A brief one-line description of the person.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The tagline.","type":"string"}}},"people_v1_UpdateContactGroupRequest":{"description":"A request to update an existing user contact group. All updated fields will be replaced.","type":"object","properties":{"contactGroup":{"$ref":"#/components/schemas/people_v1_ContactGroup"},"readGroupFields":{"description":"Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name","format":"google-fieldmask","type":"string"},"updateGroupFields":{"description":"Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name","format":"google-fieldmask","type":"string"}},"required":["contactGroup"]},"people_v1_UpdateContactPhotoRequest":{"description":"A request to update an existing contact's photo. All requests must have a valid photo format: JPEG or PNG.","type":"object","properties":{"personFields":{"description":"Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined","format":"google-fieldmask","type":"string"},"photoBytes":{"description":"Required. Raw photo bytes","format":"byte","type":"string"},"sources":{"description":"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.","type":"array","items":{"enum":["READ_SOURCE_TYPE_UNSPECIFIED","READ_SOURCE_TYPE_PROFILE","READ_SOURCE_TYPE_CONTACT","READ_SOURCE_TYPE_DOMAIN_CONTACT","READ_SOURCE_TYPE_OTHER_CONTACT"],"type":"string"}}},"required":["photoBytes"]},"people_v1_UpdateContactPhotoResponse":{"description":"The response for updating a contact's photo.","type":"object","properties":{"person":{"$ref":"#/components/schemas/people_v1_Person"}}},"people_v1_Url":{"description":"A person's associated URLs.","type":"object","properties":{"formattedType":{"description":"Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.","readOnly":true,"type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"type":{"description":"The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`","type":"string"},"value":{"description":"The URL.","type":"string"}}},"people_v1_UserDefined":{"description":"Arbitrary user data that is populated by the end users.","type":"object","properties":{"key":{"description":"The end user specified key of the user defined data.","type":"string"},"metadata":{"$ref":"#/components/schemas/people_v1_FieldMetadata"},"value":{"description":"The end user specified value of the user defined data.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/contacts":"See, edit, download, and permanently delete your contacts","https://www.googleapis.com/auth/contacts.other.readonly":"See and download contact info automatically saved in your \"Other contacts\"","https://www.googleapis.com/auth/directory.readonly":"See and download your organization's Google Workspace directory","https://www.googleapis.com/auth/user.addresses.read":"View your street addresses","https://www.googleapis.com/auth/user.birthday.read":"See and download your exact date of birth","https://www.googleapis.com/auth/user.emails.read":"See and download all of your Google Account email addresses","https://www.googleapis.com/auth/user.gender.read":"See your gender","https://www.googleapis.com/auth/user.organization.read":"See your education, work history and org info","https://www.googleapis.com/auth/user.phonenumbers.read":"See and download your personal phone numbers","https://www.googleapis.com/auth/contacts.readonly":"See and download your contacts","https://www.googleapis.com/auth/userinfo.email":"See your primary Google Account email address","https://www.googleapis.com/auth/userinfo.profile":"See your personal info, including any personal info you've made publicly available"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/contacts","https://www.googleapis.com/auth/contacts.other.readonly","https://www.googleapis.com/auth/directory.readonly","https://www.googleapis.com/auth/user.addresses.read","https://www.googleapis.com/auth/user.birthday.read","https://www.googleapis.com/auth/user.emails.read","https://www.googleapis.com/auth/user.gender.read","https://www.googleapis.com/auth/user.organization.read","https://www.googleapis.com/auth/user.phonenumbers.read"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/people/v1/rest","service":"people","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-photos-library.json b/public/specs/google/google-photos-library.json index 86463b49..61e827ca 100644 --- a/public/specs/google/google-photos-library.json +++ b/public/specs/google/google-photos-library.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Photos Library API","version":"v1","description":"Manage photos, videos, and albums created by your app in Google Photos "},"servers":[{"url":"https://photoslibrary.googleapis.com/"}],"paths":{"/v1/albums":{"get":{"operationId":"photoslibrary.albums.list","x-executor-toolPath":"photoslibrary.albums.list","tags":["Photos Library API"],"description":"Lists all albums created by your app.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"excludeNonAppCreatedData","in":"query","required":false,"description":"If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.","schema":{"description":"If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default `pageSize` is 20, the maximum is 50.","schema":{"description":"Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default `pageSize` is 20, the maximum is 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listAlbums` request.","schema":{"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listAlbums` request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_ListAlbumsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]},"post":{"operationId":"photoslibrary.albums.create","x-executor-toolPath":"photoslibrary.albums.create","tags":["Photos Library API"],"description":"Creates an album in a user's Google Photos library.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_CreateAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}},"/v1/albums/{albumId}":{"get":{"operationId":"photoslibrary.albums.get","x-executor-toolPath":"photoslibrary.albums.get","tags":["Photos Library API"],"description":"Returns the app created album based on the specified `albumId`. The `albumId` must be the ID of an album created by your app.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the album to be requested.","schema":{"description":"Required. Identifier of the album to be requested.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/albums/{albumId}:addEnrichment":{"post":{"operationId":"photoslibrary.albums.addEnrichment","x-executor-toolPath":"photoslibrary.albums.addEnrichment","tags":["Photos Library API"],"description":"Adds an enrichment at a specified position in an app created created album.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the app created album where the enrichment is to be added.","schema":{"description":"Required. Identifier of the app created album where the enrichment is to be added.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_AddEnrichmentToAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_AddEnrichmentToAlbumResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/albums/{albumId}:batchAddMediaItems":{"post":{"operationId":"photoslibrary.albums.batchAddMediaItems","x-executor-toolPath":"photoslibrary.albums.batchAddMediaItems","tags":["Photos Library API"],"description":"Adds one or more app created media items in a user's Google Photos library to an app created album. The media items and albums must have been created by the developer via the API. Media items are added to the end of the album. If multiple media items are given, they are added in the order specified in this call. Each album can contain up to 20,000 media items. Partial success is not supported. The entire request will fail if an invalid media item or album is specified.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the Album that the media items are added to.","schema":{"description":"Required. Identifier of the Album that the media items are added to.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchAddMediaItemsToAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchAddMediaItemsToAlbumResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/albums/{albumId}:batchRemoveMediaItems":{"post":{"operationId":"photoslibrary.albums.batchRemoveMediaItems","x-executor-toolPath":"photoslibrary.albums.batchRemoveMediaItems","tags":["Photos Library API"],"description":"Removes one or more app created media items from a specified app created album. The media items and the album must have been created by the developer via the API. Partial success is not supported. The entire request will fail and no action will be performed on the album if an invalid media item or album is specified.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the Album that the media items are to be removed from.","schema":{"description":"Required. Identifier of the Album that the media items are to be removed from.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchRemoveMediaItemsFromAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchRemoveMediaItemsFromAlbumResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/albums/{id}":{"patch":{"operationId":"photoslibrary.albums.patch","x-executor-toolPath":"photoslibrary.albums.patch","tags":["Photos Library API"],"description":"Update the app created album with the specified `id`. Only the `id`, `title` and `cover_photo_media_item_id` fields of the album are read. The album must have been created by the developer via the API.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.","schema":{"description":"Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Indicate what fields in the provided album to update. The only valid values are `title` and `cover_photo_media_item_id`.","schema":{"description":"Required. Indicate what fields in the provided album to update. The only valid values are `title` and `cover_photo_media_item_id`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/mediaItems":{"get":{"operationId":"photoslibrary.mediaItems.list","x-executor-toolPath":"photoslibrary.mediaItems.list","tags":["Photos Library API"],"description":"List all media items created by your app from a user's Google Photos library.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default `pageSize` is 25, the maximum is 100.","schema":{"description":"Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default `pageSize` is 25, the maximum is 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listMediaItems` request.","schema":{"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listMediaItems` request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_ListMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/mediaItems/{id}":{"patch":{"operationId":"photoslibrary.mediaItems.patch","x-executor-toolPath":"photoslibrary.mediaItems.patch","tags":["Photos Library API"],"description":"Update the app created media item with the specified `id`. Only the `id` and `description` fields of the media item are read. The media item must have been created by the developer via the API.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier for the media item. This is a persistent identifier that can be used between sessions to identify this media item.","schema":{"description":"Identifier for the media item. This is a persistent identifier that can be used between sessions to identify this media item.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Indicate what fields in the provided media item to update. The only valid value is `description`.","schema":{"description":"Required. Indicate what fields in the provided media item to update. The only valid value is `description`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/mediaItems/{mediaItemId}":{"get":{"operationId":"photoslibrary.mediaItems.get","x-executor-toolPath":"photoslibrary.mediaItems.get","tags":["Photos Library API"],"description":"Returns the app created media item for the specified media item identifier.","parameters":[{"name":"mediaItemId","in":"path","required":true,"description":"Required. Identifier of the media item to be requested.","schema":{"description":"Required. Identifier of the media item to be requested.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/mediaItems:batchCreate":{"post":{"operationId":"photoslibrary.mediaItems.batchCreate","x-executor-toolPath":"photoslibrary.mediaItems.batchCreate","tags":["Photos Library API"],"description":"Creates one or more media items in a user's Google Photos library. This is the second step for creating a media item. For details regarding Step 1, uploading the raw bytes to a Google Server, see Uploading media. This call adds the media item to the library. If an app created album `id` is specified, the call adds the media item to the album too. Each album can contain up to 20,000 media items. By default, the media item will be added to the end of the library or album. If an album `id` and position are both defined, the media item is added to the album at the specified position. If the call contains multiple media items, they're added at the specified position.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchCreateMediaItemsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchCreateMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}},"/v1/mediaItems:batchGet":{"get":{"operationId":"photoslibrary.mediaItems.batchGet","x-executor-toolPath":"photoslibrary.mediaItems.batchGet","tags":["Photos Library API"],"description":"Returns the list of app created media items for the specified media item identifiers. Items are returned in the same order as the supplied identifiers.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mediaItemIds","in":"query","required":false,"description":"Required. Identifiers of the media items to be requested. Must not contain repeated identifiers and cannot be empty. The maximum number of media items that can be retrieved in one call is 50.","schema":{"type":"array","items":{"description":"Required. Identifiers of the media items to be requested. Must not contain repeated identifiers and cannot be empty. The maximum number of media items that can be retrieved in one call is 50.","type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchGetMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/mediaItems:search":{"post":{"operationId":"photoslibrary.mediaItems.search","x-executor-toolPath":"photoslibrary.mediaItems.search","tags":["Photos Library API"],"description":"Searches for app created media items in a user's Google Photos library. Only media items and ablums created by your app are returned. If no filters are set, then all app created media items in the user's library are returned. If an app created album is set, all media items in the specified album are returned. If filters are specified, app created media items that match the filters from the user's library are listed. If you set both the album and the filters, the request results in an error.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_SearchMediaItemsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_SearchMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/uploads":{"post":{"operationId":"photoslibrary.mediaItems.upload","x-executor-toolPath":"photoslibrary.mediaItems.upload","tags":["Photos Library API"],"description":"Uploads raw photo or video bytes to Google Photos and returns a plain-text upload token. Call mediaItems.batchCreate with the returned token to create the media item.","parameters":[{"name":"X-Goog-Upload-Content-Type","in":"header","required":false,"description":"MIME type of the uploaded media, for example image/jpeg or video/mp4.","schema":{"type":"string"}},{"name":"X-Goog-Upload-File-Name","in":"header","required":true,"description":"File name Google Photos should associate with the uploaded bytes.","schema":{"type":"string"}},{"name":"X-Goog-Upload-Protocol","in":"header","required":true,"description":"Google Photos raw upload protocol. Set to raw.","schema":{"type":"string","enum":["raw"],"default":"raw"}}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"text/plain":{"schema":{"type":"string"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}}},"components":{"schemas":{"photoslibrary_v1_AddEnrichmentToAlbumRequest":{"description":"Request to add an enrichment to a specific album at a specific position.","type":"object","properties":{"albumPosition":{"$ref":"#/components/schemas/photoslibrary_v1_AlbumPosition"},"newEnrichmentItem":{"$ref":"#/components/schemas/photoslibrary_v1_NewEnrichmentItem"}}},"photoslibrary_v1_AddEnrichmentToAlbumResponse":{"description":"The enrichment item that's created.","type":"object","properties":{"enrichmentItem":{"$ref":"#/components/schemas/photoslibrary_v1_EnrichmentItem"}}},"photoslibrary_v1_Album":{"description":"Representation of an album in Google Photos. Albums are containers for media items. If an album has been shared by the application, it contains an extra `shareInfo` property.","type":"object","properties":{"coverPhotoBaseUrl":{"description":"[Output only] A URL to the cover photo's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the [developer documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls) for a complete list of supported parameters. For example, `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of 2048 px and height of 1024 px.","type":"string"},"coverPhotoMediaItemId":{"description":"Identifier for the media item associated with the cover photo.","type":"string"},"id":{"description":"Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.","type":"string"},"isWriteable":{"description":"[Output only] True if you can create media items in this album. This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated.","type":"boolean"},"mediaItemsCount":{"description":"[Output only] The number of media items in the album.","format":"int64","type":"string"},"productUrl":{"description":"[Output only] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link.","type":"string"},"shareInfo":{"$ref":"#/components/schemas/photoslibrary_v1_ShareInfo"},"title":{"description":"Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters.","type":"string"}}},"photoslibrary_v1_AlbumPosition":{"description":"Specifies a position in an album.","type":"object","properties":{"position":{"description":"Type of position, for a media or enrichment item.","enum":["POSITION_TYPE_UNSPECIFIED","FIRST_IN_ALBUM","LAST_IN_ALBUM","AFTER_MEDIA_ITEM","AFTER_ENRICHMENT_ITEM"],"type":"string"},"relativeEnrichmentItemId":{"description":"The enrichment item to which the position is relative to. Only used when position type is AFTER_ENRICHMENT_ITEM.","type":"string"},"relativeMediaItemId":{"description":"The media item to which the position is relative to. Only used when position type is AFTER_MEDIA_ITEM.","type":"string"}}},"photoslibrary_v1_BatchAddMediaItemsToAlbumRequest":{"description":"Request to add media items to an app created album.","type":"object","properties":{"mediaItemIds":{"description":"Required. Identifiers of the MediaItems to be added. The maximum number of media items that can be added in one call is 50.","type":"array","items":{"type":"string"}}}},"photoslibrary_v1_BatchAddMediaItemsToAlbumResponse":{"description":"Response for adding media items to an album.","type":"object"},"photoslibrary_v1_BatchCreateMediaItemsRequest":{"description":"Request to create one or more media items in a user's Google Photos library. If an `albumid` from an app created album is specified, the media items are also added to that album. `albumPosition` is optional and can only be specified if an `albumId` is set.","type":"object","properties":{"albumId":{"description":"Identifier of the album where the media items are added. The media items are also added to the user's library. This is an optional field.","type":"string"},"albumPosition":{"$ref":"#/components/schemas/photoslibrary_v1_AlbumPosition"},"newMediaItems":{"description":"Required. List of media items to be created. Maximum 50 media items per call.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_NewMediaItem"}}}},"photoslibrary_v1_BatchCreateMediaItemsResponse":{"description":"List of media items created.","type":"object","properties":{"newMediaItemResults":{"description":"Output only. List of media items created.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_NewMediaItemResult"}}}},"photoslibrary_v1_BatchGetMediaItemsResponse":{"description":"Response to retrieve a list of app created media items.","type":"object","properties":{"mediaItemResults":{"description":"Output only. List of media items retrieved. Note that even if the call to BatchGetMediaItems succeeds, there may have been failures for some media items in the batch. These failures are indicated in each MediaItemResult.status.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItemResult"}}}},"photoslibrary_v1_BatchRemoveMediaItemsFromAlbumRequest":{"description":"Request to remove a list of media items from an album.","type":"object","properties":{"mediaItemIds":{"description":"Required. Identifiers of the MediaItems to be removed. Must not contain repeated identifiers and cannot be empty. The maximum number of media items that can be removed in one call is 50.","type":"array","items":{"type":"string"}}}},"photoslibrary_v1_BatchRemoveMediaItemsFromAlbumResponse":{"description":"Response for successfully removing all specified media items from the album.","type":"object"},"photoslibrary_v1_ContentFilter":{"description":"This filter allows you to return media items based on the content type. It's possible to specify a list of categories to include, and/or a list of categories to exclude. Within each list, the categories are combined with an OR. The content filter `includedContentCategories`: [c1, c2, c3] would get media items that contain (c1 OR c2 OR c3). The content filter `excludedContentCategories`: [c1, c2, c3] would NOT get media items that contain (c1 OR c2 OR c3). You can also include some categories while excluding others, as in this example: `includedContentCategories`: [c1, c2], `excludedContentCategories`: [c3, c4] The previous example would get media items that contain (c1 OR c2) AND NOT (c3 OR c4). A category that appears in `includedContentategories` must not appear in `excludedContentCategories`.","type":"object","properties":{"excludedContentCategories":{"description":"The set of categories which are not to be included in the media item search results. The items in the set are ORed. There's a maximum of 10 `excludedContentCategories` per request.","type":"array","items":{"enum":["NONE","LANDSCAPES","RECEIPTS","CITYSCAPES","LANDMARKS","SELFIES","PEOPLE","PETS","WEDDINGS","BIRTHDAYS","DOCUMENTS","TRAVEL","ANIMALS","FOOD","SPORT","NIGHT","PERFORMANCES","WHITEBOARDS","SCREENSHOTS","UTILITY","ARTS","CRAFTS","FASHION","HOUSES","GARDENS","FLOWERS","HOLIDAYS"],"type":"string"}},"includedContentCategories":{"description":"The set of categories to be included in the media item search results. The items in the set are ORed. There's a maximum of 10 `includedContentCategories` per request.","type":"array","items":{"enum":["NONE","LANDSCAPES","RECEIPTS","CITYSCAPES","LANDMARKS","SELFIES","PEOPLE","PETS","WEDDINGS","BIRTHDAYS","DOCUMENTS","TRAVEL","ANIMALS","FOOD","SPORT","NIGHT","PERFORMANCES","WHITEBOARDS","SCREENSHOTS","UTILITY","ARTS","CRAFTS","FASHION","HOUSES","GARDENS","FLOWERS","HOLIDAYS"],"type":"string"}}}},"photoslibrary_v1_ContributorInfo":{"description":"Information about the user who added the media item. Note that this information is included only if the media item is within a shared album created by your app and you have the sharing scope.","type":"object","properties":{"displayName":{"description":"Display name of the contributor.","type":"string"},"profilePictureBaseUrl":{"description":"URL to the profile picture of the contributor.","type":"string"}}},"photoslibrary_v1_CreateAlbumRequest":{"description":"Request to create an album in Google Photos.","type":"object","properties":{"album":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}},"photoslibrary_v1_Date":{"description":"Represents a whole calendar date. Set `day` to 0 when only the month and year are significant, for example, all of December 2018. Set `day` and `month` to 0 if only the year is significant, for example, the entire of 2018. Set `year` to 0 when only the day and month are significant, for example, an anniversary or birthday. Unsupported: Setting all values to 0, only `month` to 0, or both `day` and `year` to 0 at the same time.","type":"object","properties":{"day":{"description":"Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day isn't significant.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"photoslibrary_v1_DateFilter":{"description":"This filter defines the allowed dates or date ranges for the media returned. It's possible to pick a set of specific dates and a set of date ranges. Media items uploaded without metadata specifying the date the media item was captured will not be returned in queries using date filters. Google Photos server upload time is not used as a fallback in this case.","type":"object","properties":{"dates":{"description":"List of dates that match the media items' creation date. A maximum of 5 dates can be included per request.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_Date"}},"ranges":{"description":"List of dates ranges that match the media items' creation date. A maximum of 5 dates ranges can be included per request.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_DateRange"}}}},"photoslibrary_v1_DateRange":{"description":"Defines a range of dates. Both dates must be of the same format. For more information, see Date.","type":"object","properties":{"endDate":{"$ref":"#/components/schemas/photoslibrary_v1_Date"},"startDate":{"$ref":"#/components/schemas/photoslibrary_v1_Date"}}},"photoslibrary_v1_EnrichmentItem":{"description":"An enrichment item.","type":"object","properties":{"id":{"description":"Identifier of the enrichment item.","type":"string"}}},"photoslibrary_v1_FeatureFilter":{"description":"This filter defines the features that the media items should have.","type":"object","properties":{"includedFeatures":{"description":"The set of features to be included in the media item search results. The items in the set are ORed and may match any of the specified features.","type":"array","items":{"enum":["NONE","FAVORITES"],"type":"string"}}}},"photoslibrary_v1_Filters":{"description":"Filters that can be applied to a media item search. If multiple filter options are specified, they're treated as AND with each other.","type":"object","properties":{"contentFilter":{"$ref":"#/components/schemas/photoslibrary_v1_ContentFilter"},"dateFilter":{"$ref":"#/components/schemas/photoslibrary_v1_DateFilter"},"excludeNonAppCreatedData":{"description":"If set, the results exclude media items that were not created by this app. Defaults to false (all media items are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.","type":"boolean"},"featureFilter":{"$ref":"#/components/schemas/photoslibrary_v1_FeatureFilter"},"includeArchivedMedia":{"description":"If set, the results include media items that the user has archived. Defaults to false (archived media items aren't included).","type":"boolean"},"mediaTypeFilter":{"$ref":"#/components/schemas/photoslibrary_v1_MediaTypeFilter"}}},"photoslibrary_v1_JoinSharedAlbumRequest":{"description":"Request to join a shared album on behalf of the user. This uses a shareToken which can be acquired via the shareAlbum or listSharedAlbums calls.","type":"object","properties":{"shareToken":{"description":"Required. Token to join the shared album on behalf of the user.","type":"string"}}},"photoslibrary_v1_JoinSharedAlbumResponse":{"description":"Response to successfully joining the shared album on behalf of the user.","type":"object","properties":{"album":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}},"photoslibrary_v1_LatLng":{"description":"An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.","type":"object","properties":{"latitude":{"description":"The latitude in degrees. It must be in the range [-90.0, +90.0].","format":"double","type":"number"},"longitude":{"description":"The longitude in degrees. It must be in the range [-180.0, +180.0].","format":"double","type":"number"}}},"photoslibrary_v1_LeaveSharedAlbumRequest":{"description":"Request to leave a shared album on behalf of the user. This uses a shareToken which can be acquired via the or listSharedAlbums or getAlbum calls.","type":"object","properties":{"shareToken":{"description":"Required. Token to leave the shared album on behalf of the user.","type":"string"}}},"photoslibrary_v1_LeaveSharedAlbumResponse":{"description":"Response to successfully leaving the shared album on behalf of the user.","type":"object"},"photoslibrary_v1_ListAlbumsResponse":{"description":"List of albums requested.","type":"object","properties":{"albums":{"description":"Output only. List of albums shown in the Albums tab of the user's Google Photos app.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}},"nextPageToken":{"description":"Output only. Token to use to get the next set of albums. Populated if there are more albums to retrieve for this request.","type":"string"}}},"photoslibrary_v1_ListMediaItemsResponse":{"description":"List of all media items from the user's Google Photos library.","type":"object","properties":{"mediaItems":{"description":"Output only. List of media items in the user's library.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}},"nextPageToken":{"description":"Output only. Token to use to get the next set of media items. Its presence is the only reliable indicator of more media items being available in the next request.","type":"string"}}},"photoslibrary_v1_ListSharedAlbumsResponse":{"description":"List of shared albums requested.","type":"object","properties":{"nextPageToken":{"description":"Output only. Token to use to get the next set of shared albums. Populated if there are more shared albums to retrieve for this request.","type":"string"},"sharedAlbums":{"description":"Output only. List of shared albums.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}},"photoslibrary_v1_Location":{"description":"Represents a physical location.","type":"object","properties":{"latlng":{"$ref":"#/components/schemas/photoslibrary_v1_LatLng"},"locationName":{"description":"Name of the location to be displayed.","type":"string"}}},"photoslibrary_v1_LocationEnrichment":{"description":"An enrichment containing a single location.","type":"object","properties":{"location":{"$ref":"#/components/schemas/photoslibrary_v1_Location"}}},"photoslibrary_v1_MapEnrichment":{"description":"An enrichment containing a map, showing origin and destination locations.","type":"object","properties":{"destination":{"$ref":"#/components/schemas/photoslibrary_v1_Location"},"origin":{"$ref":"#/components/schemas/photoslibrary_v1_Location"}}},"photoslibrary_v1_MediaItem":{"description":"Representation of a media item (such as a photo or video) in Google Photos.","type":"object","properties":{"baseUrl":{"description":"A URL to the media item's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the [developer documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls) for a complete list of supported parameters. For example, `'=w2048-h1024'` will set the dimensions of a media item of type photo to have a width of 2048 px and height of 1024 px.","type":"string"},"contributorInfo":{"$ref":"#/components/schemas/photoslibrary_v1_ContributorInfo"},"description":{"description":"Description of the media item. This is shown to the user in the item's info section in the Google Photos app. Must be shorter than 1000 characters. Only include text written by users. Descriptions should add context and help users understand media. Do not include any auto-generated strings such as filenames, tags, and other metadata.","type":"string"},"filename":{"description":"Filename of the media item. This is shown to the user in the item's info section in the Google Photos app.","type":"string"},"id":{"description":"Identifier for the media item. This is a persistent identifier that can be used between sessions to identify this media item.","type":"string"},"mediaMetadata":{"$ref":"#/components/schemas/photoslibrary_v1_MediaMetadata"},"mimeType":{"description":"MIME type of the media item. For example, `image/jpeg`.","type":"string"},"productUrl":{"description":"Google Photos URL for the media item. This link is available to the user only if they're signed in. When retrieved from an album search, the URL points to the item inside the album.","type":"string"}}},"photoslibrary_v1_MediaItemResult":{"description":"Result of retrieving a media item.","type":"object","properties":{"mediaItem":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"},"status":{"$ref":"#/components/schemas/photoslibrary_v1_Status"}}},"photoslibrary_v1_MediaMetadata":{"description":"Metadata for a media item.","type":"object","properties":{"creationTime":{"description":"Time when the media item was first created (not when it was uploaded to Google Photos).","format":"google-datetime","type":"string"},"height":{"description":"Original height (in pixels) of the media item.","format":"int64","type":"string"},"photo":{"$ref":"#/components/schemas/photoslibrary_v1_Photo"},"video":{"$ref":"#/components/schemas/photoslibrary_v1_Video"},"width":{"description":"Original width (in pixels) of the media item.","format":"int64","type":"string"}}},"photoslibrary_v1_MediaTypeFilter":{"description":"This filter defines the type of media items to be returned, for example, videos or photos. Only one media type is supported.","type":"object","properties":{"mediaTypes":{"description":"The types of media items to be included. This field should be populated with only one media type. If you specify multiple media types, it results in an error.","type":"array","items":{"enum":["ALL_MEDIA","VIDEO","PHOTO"],"type":"string"}}}},"photoslibrary_v1_NewEnrichmentItem":{"description":"A new enrichment item to be added to an app created album, used by the `albums.addEnrichment` call.","type":"object","properties":{"locationEnrichment":{"$ref":"#/components/schemas/photoslibrary_v1_LocationEnrichment"},"mapEnrichment":{"$ref":"#/components/schemas/photoslibrary_v1_MapEnrichment"},"textEnrichment":{"$ref":"#/components/schemas/photoslibrary_v1_TextEnrichment"}}},"photoslibrary_v1_NewMediaItem":{"description":"New media item that's created in a user's Google Photos account.","type":"object","properties":{"description":{"description":"Description of the media item. This is shown to the user in the item's info section in the Google Photos app. Must be shorter than 1000 characters. Only include text written by users. Descriptions should add context and help users understand media. Do not include any auto-generated strings such as filenames, tags, and other metadata.","type":"string"},"simpleMediaItem":{"$ref":"#/components/schemas/photoslibrary_v1_SimpleMediaItem"}}},"photoslibrary_v1_NewMediaItemResult":{"description":"Result of creating a new media item.","type":"object","properties":{"mediaItem":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"},"status":{"$ref":"#/components/schemas/photoslibrary_v1_Status"},"uploadToken":{"description":"The upload token used to create this new (simple) media item. Only populated if the media item is simple and required a single upload token.","type":"string"}}},"photoslibrary_v1_Photo":{"description":"Metadata that is specific to a photo, such as, ISO, focal length and exposure time. Some of these fields may be null or not included.","type":"object","properties":{"apertureFNumber":{"description":"Aperture f number of the camera lens with which the photo was taken.","format":"float","type":"number"},"cameraMake":{"description":"Brand of the camera with which the photo was taken.","type":"string"},"cameraModel":{"description":"Model of the camera with which the photo was taken.","type":"string"},"exposureTime":{"description":"Exposure time of the camera aperture when the photo was taken.","format":"google-duration","type":"string"},"focalLength":{"description":"Focal length of the camera lens with which the photo was taken.","format":"float","type":"number"},"isoEquivalent":{"description":"ISO of the camera with which the photo was taken.","format":"int32","type":"integer"}}},"photoslibrary_v1_SearchMediaItemsRequest":{"description":"Request to search for app created media items in a user's library. If the album id from an app created album is specified, this call will return the list of media items in the album. If neither filters nor album id are specified, this call will return all app created media items in a user's Google Photos library. If filters are specified, this call will return all app created media items in the user's library that fulfill the filter criteria. Filters and album id must not both be set, as this will result in an invalid request.","type":"object","properties":{"albumId":{"description":"Identifier of an album. If populated, lists all media items in specified album. Can't set in conjunction with any filters.","type":"string"},"filters":{"$ref":"#/components/schemas/photoslibrary_v1_Filters"},"orderBy":{"description":"An optional field to specify the sort order of the search results. The `orderBy` field only works when a dateFilter is used. When this field is not specified, results are displayed newest first, oldest last by their creationTime. Providing `MediaMetadata.creation_time` displays search results in the opposite order, oldest first then newest last. To display results newest first then oldest last, include the `desc` argument as follows: `MediaMetadata.creation_time desc`. The only additional filters that can be used with this parameter are includeArchivedMedia and excludeNonAppCreatedData. No other filters are supported.","type":"string"},"pageSize":{"description":"Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default `pageSize` is 25, the maximum is 100.","format":"int32","type":"integer"},"pageToken":{"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `searchMediaItems` request.","type":"string"}}},"photoslibrary_v1_SearchMediaItemsResponse":{"description":"List of media items that match the search parameters.","type":"object","properties":{"mediaItems":{"description":"Output only. List of media items that match the search parameters.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}},"nextPageToken":{"description":"Output only. Use this token to get the next set of media items. Its presence is the only reliable indicator of more media items being available in the next request.","type":"string"}}},"photoslibrary_v1_ShareAlbumRequest":{"description":"Request to make an album shared in Google Photos.","type":"object","properties":{"sharedAlbumOptions":{"$ref":"#/components/schemas/photoslibrary_v1_SharedAlbumOptions"}}},"photoslibrary_v1_ShareAlbumResponse":{"description":"Response to successfully sharing an album.","type":"object","properties":{"shareInfo":{"$ref":"#/components/schemas/photoslibrary_v1_ShareInfo"}}},"photoslibrary_v1_ShareInfo":{"description":"Information about albums that are shared. This information is only included if you created the album, it is shared and you have the sharing scope.","type":"object","properties":{"isJoinable":{"description":"True if the album can be joined by users.","type":"boolean"},"isJoined":{"description":"True if the user is joined to the album. This is always true for the owner of the album.","type":"boolean"},"isOwned":{"description":"True if the user owns the album.","type":"boolean"},"shareToken":{"description":"A token that is used to join, leave, or retrieve the details of a shared album on behalf of a user who isn't the owner. A `shareToken` is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.","type":"string"},"shareableUrl":{"description":"A link to the shared Google Photos album. Anyone with the link can view the contents of the album, so it should be treated with care. The `shareableUrl` parameter is only returned if the album has link sharing turned on. If a user is already joined to an album that isn't link-shared, they can use the album's [`productUrl`](https://developers.google.com/photos/library/reference/rest/v1/albums#Album) to access it instead. A `shareableUrl` is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.","type":"string"},"sharedAlbumOptions":{"$ref":"#/components/schemas/photoslibrary_v1_SharedAlbumOptions"}}},"photoslibrary_v1_SharedAlbumOptions":{"description":"Options that control the sharing of an album.","type":"object","properties":{"isCollaborative":{"description":"True if the shared album allows collaborators (users who have joined the album) to add media items to it. Defaults to false.","type":"boolean"},"isCommentable":{"description":"True if the shared album allows collaborators (users who have joined the album) to add comments to the album. Defaults to false.","type":"boolean"}}},"photoslibrary_v1_SimpleMediaItem":{"description":"A simple media item to be created in Google Photos via an upload token.","type":"object","properties":{"fileName":{"description":"File name with extension of the media item. This is shown to the user in Google Photos. The file name specified during the byte upload process is ignored if this field is set. The file name, including the file extension, shouldn't be more than 255 characters. This is an optional field.","type":"string"},"uploadToken":{"description":"Token identifying the media bytes that have been uploaded to Google.","type":"string"}}},"photoslibrary_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"photoslibrary_v1_TextEnrichment":{"description":"An enrichment containing text.","type":"object","properties":{"text":{"description":"Text for this enrichment item.","type":"string"}}},"photoslibrary_v1_UnshareAlbumRequest":{"description":"Request to unshare a shared album in Google Photos.","type":"object"},"photoslibrary_v1_UnshareAlbumResponse":{"description":"Response of a successful unshare of a shared album.","type":"object"},"photoslibrary_v1_Video":{"description":"Metadata that is specific to a video, for example, fps and processing status. Some of these fields may be null or not included.","type":"object","properties":{"cameraMake":{"description":"Brand of the camera with which the video was taken.","type":"string"},"cameraModel":{"description":"Model of the camera with which the video was taken.","type":"string"},"fps":{"description":"Frame rate of the video.","format":"double","type":"number"},"status":{"description":"Processing status of the video.","enum":["UNSPECIFIED","PROCESSING","READY","FAILED"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/photoslibrary.appendonly":"","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata":"","https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/photoslibrary.appendonly","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata","https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/photoslibrary/v1/rest","service":"photoslibrary","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Photos Library API","version":"v1","description":"Manage photos, videos, and albums created by your app in Google Photos "},"servers":[{"url":"https://photoslibrary.googleapis.com/"}],"paths":{"/v1/albums":{"get":{"operationId":"photoslibrary.albums.list","x-executor-toolPath":"photoslibrary.albums.list","tags":["Photos Library API"],"description":"Lists all albums created by your app.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"excludeNonAppCreatedData","in":"query","required":false,"description":"If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.","schema":{"description":"If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default `pageSize` is 20, the maximum is 50.","schema":{"description":"Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default `pageSize` is 20, the maximum is 50.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listAlbums` request.","schema":{"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listAlbums` request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_ListAlbumsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]},"post":{"operationId":"photoslibrary.albums.create","x-executor-toolPath":"photoslibrary.albums.create","tags":["Photos Library API"],"description":"Creates an album in a user's Google Photos library.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_CreateAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}},"/v1/albums/{albumId}":{"get":{"operationId":"photoslibrary.albums.get","x-executor-toolPath":"photoslibrary.albums.get","tags":["Photos Library API"],"description":"Returns the app created album based on the specified `albumId`. The `albumId` must be the ID of an album created by your app.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the album to be requested.","schema":{"description":"Required. Identifier of the album to be requested.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/albums/{albumId}:addEnrichment":{"post":{"operationId":"photoslibrary.albums.addEnrichment","x-executor-toolPath":"photoslibrary.albums.addEnrichment","tags":["Photos Library API"],"description":"Adds an enrichment at a specified position in an app created created album.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the app created album where the enrichment is to be added.","schema":{"description":"Required. Identifier of the app created album where the enrichment is to be added.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_AddEnrichmentToAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_AddEnrichmentToAlbumResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/albums/{albumId}:batchAddMediaItems":{"post":{"operationId":"photoslibrary.albums.batchAddMediaItems","x-executor-toolPath":"photoslibrary.albums.batchAddMediaItems","tags":["Photos Library API"],"description":"Adds one or more app created media items in a user's Google Photos library to an app created album. The media items and albums must have been created by the developer via the API. Media items are added to the end of the album. If multiple media items are given, they are added in the order specified in this call. Each album can contain up to 20,000 media items. Partial success is not supported. The entire request will fail if an invalid media item or album is specified.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the Album that the media items are added to.","schema":{"description":"Required. Identifier of the Album that the media items are added to.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchAddMediaItemsToAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchAddMediaItemsToAlbumResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/albums/{albumId}:batchRemoveMediaItems":{"post":{"operationId":"photoslibrary.albums.batchRemoveMediaItems","x-executor-toolPath":"photoslibrary.albums.batchRemoveMediaItems","tags":["Photos Library API"],"description":"Removes one or more app created media items from a specified app created album. The media items and the album must have been created by the developer via the API. Partial success is not supported. The entire request will fail and no action will be performed on the album if an invalid media item or album is specified.","parameters":[{"name":"albumId","in":"path","required":true,"description":"Required. Identifier of the Album that the media items are to be removed from.","schema":{"description":"Required. Identifier of the Album that the media items are to be removed from.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchRemoveMediaItemsFromAlbumRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchRemoveMediaItemsFromAlbumResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/albums/{id}":{"patch":{"operationId":"photoslibrary.albums.patch","x-executor-toolPath":"photoslibrary.albums.patch","tags":["Photos Library API"],"description":"Update the app created album with the specified `id`. Only the `id`, `title` and `cover_photo_media_item_id` fields of the album are read. The album must have been created by the developer via the API.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.","schema":{"description":"Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Indicate what fields in the provided album to update. The only valid values are `title` and `cover_photo_media_item_id`.","schema":{"description":"Required. Indicate what fields in the provided album to update. The only valid values are `title` and `cover_photo_media_item_id`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/mediaItems":{"get":{"operationId":"photoslibrary.mediaItems.list","x-executor-toolPath":"photoslibrary.mediaItems.list","tags":["Photos Library API"],"description":"List all media items created by your app from a user's Google Photos library.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default `pageSize` is 25, the maximum is 100.","schema":{"description":"Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default `pageSize` is 25, the maximum is 100.","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listMediaItems` request.","schema":{"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listMediaItems` request.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_ListMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/mediaItems/{id}":{"patch":{"operationId":"photoslibrary.mediaItems.patch","x-executor-toolPath":"photoslibrary.mediaItems.patch","tags":["Photos Library API"],"description":"Update the app created media item with the specified `id`. Only the `id` and `description` fields of the media item are read. The media item must have been created by the developer via the API.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier for the media item. This is a persistent identifier that can be used between sessions to identify this media item.","schema":{"description":"Identifier for the media item. This is a persistent identifier that can be used between sessions to identify this media item.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"updateMask","in":"query","required":false,"description":"Required. Indicate what fields in the provided media item to update. The only valid value is `description`.","schema":{"description":"Required. Indicate what fields in the provided media item to update. The only valid value is `description`.","format":"google-fieldmask","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata"]}},"/v1/mediaItems/{mediaItemId}":{"get":{"operationId":"photoslibrary.mediaItems.get","x-executor-toolPath":"photoslibrary.mediaItems.get","tags":["Photos Library API"],"description":"Returns the app created media item for the specified media item identifier.","parameters":[{"name":"mediaItemId","in":"path","required":true,"description":"Required. Identifier of the media item to be requested.","schema":{"description":"Required. Identifier of the media item to be requested.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/mediaItems:batchCreate":{"post":{"operationId":"photoslibrary.mediaItems.batchCreate","x-executor-toolPath":"photoslibrary.mediaItems.batchCreate","tags":["Photos Library API"],"description":"Creates one or more media items in a user's Google Photos library. This is the second step for creating a media item. For details regarding Step 1, uploading the raw bytes to a Google Server, see Uploading media. This call adds the media item to the library. If an app created album `id` is specified, the call adds the media item to the album too. Each album can contain up to 20,000 media items. By default, the media item will be added to the end of the library or album. If an album `id` and position are both defined, the media item is added to the album at the specified position. If the call contains multiple media items, they're added at the specified position.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchCreateMediaItemsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchCreateMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}},"/v1/mediaItems:batchGet":{"get":{"operationId":"photoslibrary.mediaItems.batchGet","x-executor-toolPath":"photoslibrary.mediaItems.batchGet","tags":["Photos Library API"],"description":"Returns the list of app created media items for the specified media item identifiers. Items are returned in the same order as the supplied identifiers.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mediaItemIds","in":"query","required":false,"description":"Required. Identifiers of the media items to be requested. Must not contain repeated identifiers and cannot be empty. The maximum number of media items that can be retrieved in one call is 50.","schema":{"type":"array","items":{"description":"Required. Identifiers of the media items to be requested. Must not contain repeated identifiers and cannot be empty. The maximum number of media items that can be retrieved in one call is 50.","type":"string"}},"style":"form","explode":true},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_BatchGetMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/mediaItems:search":{"post":{"operationId":"photoslibrary.mediaItems.search","x-executor-toolPath":"photoslibrary.mediaItems.search","tags":["Photos Library API"],"description":"Searches for app created media items in a user's Google Photos library. Only media items and ablums created by your app are returned. If no filters are set, then all app created media items in the user's library are returned. If an app created album is set, all media items in the specified album are returned. If filters are specified, app created media items that match the filters from the user's library are listed. If you set both the album and the filters, the request results in an error.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_SearchMediaItemsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/photoslibrary_v1_SearchMediaItemsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}},"/v1/uploads":{"post":{"operationId":"photoslibrary.mediaItems.upload","x-executor-toolPath":"photoslibrary.mediaItems.upload","tags":["Photos Library API"],"description":"Uploads raw photo or video bytes to Google Photos and returns a plain-text upload token. Call mediaItems.batchCreate with the returned token to create the media item.","parameters":[{"name":"X-Goog-Upload-Content-Type","in":"header","required":false,"description":"MIME type of the uploaded media, for example image/jpeg or video/mp4.","schema":{"type":"string"}},{"name":"X-Goog-Upload-File-Name","in":"header","required":true,"description":"File name Google Photos should associate with the uploaded bytes.","schema":{"type":"string"}},{"name":"X-Goog-Upload-Protocol","in":"header","required":true,"description":"Google Photos raw upload protocol. Set to raw.","schema":{"type":"string","enum":["raw"],"default":"raw"}}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"text/plain":{"schema":{"type":"string"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}],"x-google-scopes":["https://www.googleapis.com/auth/photoslibrary.appendonly"]}}},"components":{"schemas":{"photoslibrary_v1_AddEnrichmentToAlbumRequest":{"description":"Request to add an enrichment to a specific album at a specific position.","type":"object","properties":{"albumPosition":{"$ref":"#/components/schemas/photoslibrary_v1_AlbumPosition"},"newEnrichmentItem":{"$ref":"#/components/schemas/photoslibrary_v1_NewEnrichmentItem"}}},"photoslibrary_v1_AddEnrichmentToAlbumResponse":{"description":"The enrichment item that's created.","type":"object","properties":{"enrichmentItem":{"$ref":"#/components/schemas/photoslibrary_v1_EnrichmentItem"}}},"photoslibrary_v1_Album":{"description":"Representation of an album in Google Photos. Albums are containers for media items. If an album has been shared by the application, it contains an extra `shareInfo` property.","type":"object","properties":{"coverPhotoBaseUrl":{"description":"[Output only] A URL to the cover photo's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the [developer documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls) for a complete list of supported parameters. For example, `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of 2048 px and height of 1024 px.","type":"string"},"coverPhotoMediaItemId":{"description":"Identifier for the media item associated with the cover photo.","type":"string"},"id":{"description":"Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.","type":"string"},"isWriteable":{"description":"[Output only] True if you can create media items in this album. This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated.","type":"boolean"},"mediaItemsCount":{"description":"[Output only] The number of media items in the album.","format":"int64","type":"string"},"productUrl":{"description":"[Output only] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link.","type":"string"},"shareInfo":{"$ref":"#/components/schemas/photoslibrary_v1_ShareInfo"},"title":{"description":"Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters.","type":"string"}}},"photoslibrary_v1_AlbumPosition":{"description":"Specifies a position in an album.","type":"object","properties":{"position":{"description":"Type of position, for a media or enrichment item.","enum":["POSITION_TYPE_UNSPECIFIED","FIRST_IN_ALBUM","LAST_IN_ALBUM","AFTER_MEDIA_ITEM","AFTER_ENRICHMENT_ITEM"],"type":"string"},"relativeEnrichmentItemId":{"description":"The enrichment item to which the position is relative to. Only used when position type is AFTER_ENRICHMENT_ITEM.","type":"string"},"relativeMediaItemId":{"description":"The media item to which the position is relative to. Only used when position type is AFTER_MEDIA_ITEM.","type":"string"}}},"photoslibrary_v1_BatchAddMediaItemsToAlbumRequest":{"description":"Request to add media items to an app created album.","type":"object","properties":{"mediaItemIds":{"description":"Required. Identifiers of the MediaItems to be added. The maximum number of media items that can be added in one call is 50.","type":"array","items":{"type":"string"}}}},"photoslibrary_v1_BatchAddMediaItemsToAlbumResponse":{"description":"Response for adding media items to an album.","type":"object"},"photoslibrary_v1_BatchCreateMediaItemsRequest":{"description":"Request to create one or more media items in a user's Google Photos library. If an `albumid` from an app created album is specified, the media items are also added to that album. `albumPosition` is optional and can only be specified if an `albumId` is set.","type":"object","properties":{"albumId":{"description":"Identifier of the album where the media items are added. The media items are also added to the user's library. This is an optional field.","type":"string"},"albumPosition":{"$ref":"#/components/schemas/photoslibrary_v1_AlbumPosition"},"newMediaItems":{"description":"Required. List of media items to be created. Maximum 50 media items per call.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_NewMediaItem"}}}},"photoslibrary_v1_BatchCreateMediaItemsResponse":{"description":"List of media items created.","type":"object","properties":{"newMediaItemResults":{"description":"Output only. List of media items created.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_NewMediaItemResult"}}}},"photoslibrary_v1_BatchGetMediaItemsResponse":{"description":"Response to retrieve a list of app created media items.","type":"object","properties":{"mediaItemResults":{"description":"Output only. List of media items retrieved. Note that even if the call to BatchGetMediaItems succeeds, there may have been failures for some media items in the batch. These failures are indicated in each MediaItemResult.status.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItemResult"}}}},"photoslibrary_v1_BatchRemoveMediaItemsFromAlbumRequest":{"description":"Request to remove a list of media items from an album.","type":"object","properties":{"mediaItemIds":{"description":"Required. Identifiers of the MediaItems to be removed. Must not contain repeated identifiers and cannot be empty. The maximum number of media items that can be removed in one call is 50.","type":"array","items":{"type":"string"}}}},"photoslibrary_v1_BatchRemoveMediaItemsFromAlbumResponse":{"description":"Response for successfully removing all specified media items from the album.","type":"object"},"photoslibrary_v1_ContentFilter":{"description":"This filter allows you to return media items based on the content type. It's possible to specify a list of categories to include, and/or a list of categories to exclude. Within each list, the categories are combined with an OR. The content filter `includedContentCategories`: [c1, c2, c3] would get media items that contain (c1 OR c2 OR c3). The content filter `excludedContentCategories`: [c1, c2, c3] would NOT get media items that contain (c1 OR c2 OR c3). You can also include some categories while excluding others, as in this example: `includedContentCategories`: [c1, c2], `excludedContentCategories`: [c3, c4] The previous example would get media items that contain (c1 OR c2) AND NOT (c3 OR c4). A category that appears in `includedContentategories` must not appear in `excludedContentCategories`.","type":"object","properties":{"excludedContentCategories":{"description":"The set of categories which are not to be included in the media item search results. The items in the set are ORed. There's a maximum of 10 `excludedContentCategories` per request.","type":"array","items":{"enum":["NONE","LANDSCAPES","RECEIPTS","CITYSCAPES","LANDMARKS","SELFIES","PEOPLE","PETS","WEDDINGS","BIRTHDAYS","DOCUMENTS","TRAVEL","ANIMALS","FOOD","SPORT","NIGHT","PERFORMANCES","WHITEBOARDS","SCREENSHOTS","UTILITY","ARTS","CRAFTS","FASHION","HOUSES","GARDENS","FLOWERS","HOLIDAYS"],"type":"string"}},"includedContentCategories":{"description":"The set of categories to be included in the media item search results. The items in the set are ORed. There's a maximum of 10 `includedContentCategories` per request.","type":"array","items":{"enum":["NONE","LANDSCAPES","RECEIPTS","CITYSCAPES","LANDMARKS","SELFIES","PEOPLE","PETS","WEDDINGS","BIRTHDAYS","DOCUMENTS","TRAVEL","ANIMALS","FOOD","SPORT","NIGHT","PERFORMANCES","WHITEBOARDS","SCREENSHOTS","UTILITY","ARTS","CRAFTS","FASHION","HOUSES","GARDENS","FLOWERS","HOLIDAYS"],"type":"string"}}}},"photoslibrary_v1_ContributorInfo":{"description":"Information about the user who added the media item. Note that this information is included only if the media item is within a shared album created by your app and you have the sharing scope.","type":"object","properties":{"displayName":{"description":"Display name of the contributor.","type":"string"},"profilePictureBaseUrl":{"description":"URL to the profile picture of the contributor.","type":"string"}}},"photoslibrary_v1_CreateAlbumRequest":{"description":"Request to create an album in Google Photos.","type":"object","properties":{"album":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}},"photoslibrary_v1_Date":{"description":"Represents a whole calendar date. Set `day` to 0 when only the month and year are significant, for example, all of December 2018. Set `day` and `month` to 0 if only the year is significant, for example, the entire of 2018. Set `year` to 0 when only the day and month are significant, for example, an anniversary or birthday. Unsupported: Setting all values to 0, only `month` to 0, or both `day` and `year` to 0 at the same time.","type":"object","properties":{"day":{"description":"Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day isn't significant.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}}},"photoslibrary_v1_DateFilter":{"description":"This filter defines the allowed dates or date ranges for the media returned. It's possible to pick a set of specific dates and a set of date ranges. Media items uploaded without metadata specifying the date the media item was captured will not be returned in queries using date filters. Google Photos server upload time is not used as a fallback in this case.","type":"object","properties":{"dates":{"description":"List of dates that match the media items' creation date. A maximum of 5 dates can be included per request.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_Date"}},"ranges":{"description":"List of dates ranges that match the media items' creation date. A maximum of 5 dates ranges can be included per request.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_DateRange"}}}},"photoslibrary_v1_DateRange":{"description":"Defines a range of dates. Both dates must be of the same format. For more information, see Date.","type":"object","properties":{"endDate":{"$ref":"#/components/schemas/photoslibrary_v1_Date"},"startDate":{"$ref":"#/components/schemas/photoslibrary_v1_Date"}}},"photoslibrary_v1_EnrichmentItem":{"description":"An enrichment item.","type":"object","properties":{"id":{"description":"Identifier of the enrichment item.","type":"string"}}},"photoslibrary_v1_FeatureFilter":{"description":"This filter defines the features that the media items should have.","type":"object","properties":{"includedFeatures":{"description":"The set of features to be included in the media item search results. The items in the set are ORed and may match any of the specified features.","type":"array","items":{"enum":["NONE","FAVORITES"],"type":"string"}}}},"photoslibrary_v1_Filters":{"description":"Filters that can be applied to a media item search. If multiple filter options are specified, they're treated as AND with each other.","type":"object","properties":{"contentFilter":{"$ref":"#/components/schemas/photoslibrary_v1_ContentFilter"},"dateFilter":{"$ref":"#/components/schemas/photoslibrary_v1_DateFilter"},"excludeNonAppCreatedData":{"description":"If set, the results exclude media items that were not created by this app. Defaults to false (all media items are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.","type":"boolean"},"featureFilter":{"$ref":"#/components/schemas/photoslibrary_v1_FeatureFilter"},"includeArchivedMedia":{"description":"If set, the results include media items that the user has archived. Defaults to false (archived media items aren't included).","type":"boolean"},"mediaTypeFilter":{"$ref":"#/components/schemas/photoslibrary_v1_MediaTypeFilter"}}},"photoslibrary_v1_JoinSharedAlbumRequest":{"description":"Request to join a shared album on behalf of the user. This uses a shareToken which can be acquired via the shareAlbum or listSharedAlbums calls.","type":"object","properties":{"shareToken":{"description":"Required. Token to join the shared album on behalf of the user.","type":"string"}}},"photoslibrary_v1_JoinSharedAlbumResponse":{"description":"Response to successfully joining the shared album on behalf of the user.","type":"object","properties":{"album":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}},"photoslibrary_v1_LatLng":{"description":"An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.","type":"object","properties":{"latitude":{"description":"The latitude in degrees. It must be in the range [-90.0, +90.0].","format":"double","type":"number"},"longitude":{"description":"The longitude in degrees. It must be in the range [-180.0, +180.0].","format":"double","type":"number"}}},"photoslibrary_v1_LeaveSharedAlbumRequest":{"description":"Request to leave a shared album on behalf of the user. This uses a shareToken which can be acquired via the or listSharedAlbums or getAlbum calls.","type":"object","properties":{"shareToken":{"description":"Required. Token to leave the shared album on behalf of the user.","type":"string"}}},"photoslibrary_v1_LeaveSharedAlbumResponse":{"description":"Response to successfully leaving the shared album on behalf of the user.","type":"object"},"photoslibrary_v1_ListAlbumsResponse":{"description":"List of albums requested.","type":"object","properties":{"albums":{"description":"Output only. List of albums shown in the Albums tab of the user's Google Photos app.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}},"nextPageToken":{"description":"Output only. Token to use to get the next set of albums. Populated if there are more albums to retrieve for this request.","type":"string"}}},"photoslibrary_v1_ListMediaItemsResponse":{"description":"List of all media items from the user's Google Photos library.","type":"object","properties":{"mediaItems":{"description":"Output only. List of media items in the user's library.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}},"nextPageToken":{"description":"Output only. Token to use to get the next set of media items. Its presence is the only reliable indicator of more media items being available in the next request.","type":"string"}}},"photoslibrary_v1_ListSharedAlbumsResponse":{"description":"List of shared albums requested.","type":"object","properties":{"nextPageToken":{"description":"Output only. Token to use to get the next set of shared albums. Populated if there are more shared albums to retrieve for this request.","type":"string"},"sharedAlbums":{"description":"Output only. List of shared albums.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_Album"}}}},"photoslibrary_v1_Location":{"description":"Represents a physical location.","type":"object","properties":{"latlng":{"$ref":"#/components/schemas/photoslibrary_v1_LatLng"},"locationName":{"description":"Name of the location to be displayed.","type":"string"}}},"photoslibrary_v1_LocationEnrichment":{"description":"An enrichment containing a single location.","type":"object","properties":{"location":{"$ref":"#/components/schemas/photoslibrary_v1_Location"}}},"photoslibrary_v1_MapEnrichment":{"description":"An enrichment containing a map, showing origin and destination locations.","type":"object","properties":{"destination":{"$ref":"#/components/schemas/photoslibrary_v1_Location"},"origin":{"$ref":"#/components/schemas/photoslibrary_v1_Location"}}},"photoslibrary_v1_MediaItem":{"description":"Representation of a media item (such as a photo or video) in Google Photos.","type":"object","properties":{"baseUrl":{"description":"A URL to the media item's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the [developer documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls) for a complete list of supported parameters. For example, `'=w2048-h1024'` will set the dimensions of a media item of type photo to have a width of 2048 px and height of 1024 px.","type":"string"},"contributorInfo":{"$ref":"#/components/schemas/photoslibrary_v1_ContributorInfo"},"description":{"description":"Description of the media item. This is shown to the user in the item's info section in the Google Photos app. Must be shorter than 1000 characters. Only include text written by users. Descriptions should add context and help users understand media. Do not include any auto-generated strings such as filenames, tags, and other metadata.","type":"string"},"filename":{"description":"Filename of the media item. This is shown to the user in the item's info section in the Google Photos app.","type":"string"},"id":{"description":"Identifier for the media item. This is a persistent identifier that can be used between sessions to identify this media item.","type":"string"},"mediaMetadata":{"$ref":"#/components/schemas/photoslibrary_v1_MediaMetadata"},"mimeType":{"description":"MIME type of the media item. For example, `image/jpeg`.","type":"string"},"productUrl":{"description":"Google Photos URL for the media item. This link is available to the user only if they're signed in. When retrieved from an album search, the URL points to the item inside the album.","type":"string"}}},"photoslibrary_v1_MediaItemResult":{"description":"Result of retrieving a media item.","type":"object","properties":{"mediaItem":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"},"status":{"$ref":"#/components/schemas/photoslibrary_v1_Status"}}},"photoslibrary_v1_MediaMetadata":{"description":"Metadata for a media item.","type":"object","properties":{"creationTime":{"description":"Time when the media item was first created (not when it was uploaded to Google Photos).","format":"google-datetime","type":"string"},"height":{"description":"Original height (in pixels) of the media item.","format":"int64","type":"string"},"photo":{"$ref":"#/components/schemas/photoslibrary_v1_Photo"},"video":{"$ref":"#/components/schemas/photoslibrary_v1_Video"},"width":{"description":"Original width (in pixels) of the media item.","format":"int64","type":"string"}}},"photoslibrary_v1_MediaTypeFilter":{"description":"This filter defines the type of media items to be returned, for example, videos or photos. Only one media type is supported.","type":"object","properties":{"mediaTypes":{"description":"The types of media items to be included. This field should be populated with only one media type. If you specify multiple media types, it results in an error.","type":"array","items":{"enum":["ALL_MEDIA","VIDEO","PHOTO"],"type":"string"}}}},"photoslibrary_v1_NewEnrichmentItem":{"description":"A new enrichment item to be added to an app created album, used by the `albums.addEnrichment` call.","type":"object","properties":{"locationEnrichment":{"$ref":"#/components/schemas/photoslibrary_v1_LocationEnrichment"},"mapEnrichment":{"$ref":"#/components/schemas/photoslibrary_v1_MapEnrichment"},"textEnrichment":{"$ref":"#/components/schemas/photoslibrary_v1_TextEnrichment"}}},"photoslibrary_v1_NewMediaItem":{"description":"New media item that's created in a user's Google Photos account.","type":"object","properties":{"description":{"description":"Description of the media item. This is shown to the user in the item's info section in the Google Photos app. Must be shorter than 1000 characters. Only include text written by users. Descriptions should add context and help users understand media. Do not include any auto-generated strings such as filenames, tags, and other metadata.","type":"string"},"simpleMediaItem":{"$ref":"#/components/schemas/photoslibrary_v1_SimpleMediaItem"}}},"photoslibrary_v1_NewMediaItemResult":{"description":"Result of creating a new media item.","type":"object","properties":{"mediaItem":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"},"status":{"$ref":"#/components/schemas/photoslibrary_v1_Status"},"uploadToken":{"description":"The upload token used to create this new (simple) media item. Only populated if the media item is simple and required a single upload token.","type":"string"}}},"photoslibrary_v1_Photo":{"description":"Metadata that is specific to a photo, such as, ISO, focal length and exposure time. Some of these fields may be null or not included.","type":"object","properties":{"apertureFNumber":{"description":"Aperture f number of the camera lens with which the photo was taken.","format":"float","type":"number"},"cameraMake":{"description":"Brand of the camera with which the photo was taken.","type":"string"},"cameraModel":{"description":"Model of the camera with which the photo was taken.","type":"string"},"exposureTime":{"description":"Exposure time of the camera aperture when the photo was taken.","format":"google-duration","type":"string"},"focalLength":{"description":"Focal length of the camera lens with which the photo was taken.","format":"float","type":"number"},"isoEquivalent":{"description":"ISO of the camera with which the photo was taken.","format":"int32","type":"integer"}}},"photoslibrary_v1_SearchMediaItemsRequest":{"description":"Request to search for app created media items in a user's library. If the album id from an app created album is specified, this call will return the list of media items in the album. If neither filters nor album id are specified, this call will return all app created media items in a user's Google Photos library. If filters are specified, this call will return all app created media items in the user's library that fulfill the filter criteria. Filters and album id must not both be set, as this will result in an invalid request.","type":"object","properties":{"albumId":{"description":"Identifier of an album. If populated, lists all media items in specified album. Can't set in conjunction with any filters.","type":"string"},"filters":{"$ref":"#/components/schemas/photoslibrary_v1_Filters"},"orderBy":{"description":"An optional field to specify the sort order of the search results. The `orderBy` field only works when a dateFilter is used. When this field is not specified, results are displayed newest first, oldest last by their creationTime. Providing `MediaMetadata.creation_time` displays search results in the opposite order, oldest first then newest last. To display results newest first then oldest last, include the `desc` argument as follows: `MediaMetadata.creation_time desc`. The only additional filters that can be used with this parameter are includeArchivedMedia and excludeNonAppCreatedData. No other filters are supported.","type":"string"},"pageSize":{"description":"Maximum number of media items to return in the response. Fewer media items might be returned than the specified number. The default `pageSize` is 25, the maximum is 100.","format":"int32","type":"integer"},"pageToken":{"description":"A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `searchMediaItems` request.","type":"string"}}},"photoslibrary_v1_SearchMediaItemsResponse":{"description":"List of media items that match the search parameters.","type":"object","properties":{"mediaItems":{"description":"Output only. List of media items that match the search parameters.","type":"array","items":{"$ref":"#/components/schemas/photoslibrary_v1_MediaItem"}},"nextPageToken":{"description":"Output only. Use this token to get the next set of media items. Its presence is the only reliable indicator of more media items being available in the next request.","type":"string"}}},"photoslibrary_v1_ShareAlbumRequest":{"description":"Request to make an album shared in Google Photos.","type":"object","properties":{"sharedAlbumOptions":{"$ref":"#/components/schemas/photoslibrary_v1_SharedAlbumOptions"}}},"photoslibrary_v1_ShareAlbumResponse":{"description":"Response to successfully sharing an album.","type":"object","properties":{"shareInfo":{"$ref":"#/components/schemas/photoslibrary_v1_ShareInfo"}}},"photoslibrary_v1_ShareInfo":{"description":"Information about albums that are shared. This information is only included if you created the album, it is shared and you have the sharing scope.","type":"object","properties":{"isJoinable":{"description":"True if the album can be joined by users.","type":"boolean"},"isJoined":{"description":"True if the user is joined to the album. This is always true for the owner of the album.","type":"boolean"},"isOwned":{"description":"True if the user owns the album.","type":"boolean"},"shareToken":{"description":"A token that is used to join, leave, or retrieve the details of a shared album on behalf of a user who isn't the owner. A `shareToken` is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.","type":"string"},"shareableUrl":{"description":"A link to the shared Google Photos album. Anyone with the link can view the contents of the album, so it should be treated with care. The `shareableUrl` parameter is only returned if the album has link sharing turned on. If a user is already joined to an album that isn't link-shared, they can use the album's [`productUrl`](https://developers.google.com/photos/library/reference/rest/v1/albums#Album) to access it instead. A `shareableUrl` is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.","type":"string"},"sharedAlbumOptions":{"$ref":"#/components/schemas/photoslibrary_v1_SharedAlbumOptions"}}},"photoslibrary_v1_SharedAlbumOptions":{"description":"Options that control the sharing of an album.","type":"object","properties":{"isCollaborative":{"description":"True if the shared album allows collaborators (users who have joined the album) to add media items to it. Defaults to false.","type":"boolean"},"isCommentable":{"description":"True if the shared album allows collaborators (users who have joined the album) to add comments to the album. Defaults to false.","type":"boolean"}}},"photoslibrary_v1_SimpleMediaItem":{"description":"A simple media item to be created in Google Photos via an upload token.","type":"object","properties":{"fileName":{"description":"File name with extension of the media item. This is shown to the user in Google Photos. The file name specified during the byte upload process is ignored if this field is set. The file name, including the file extension, shouldn't be more than 255 characters. This is an optional field.","type":"string"},"uploadToken":{"description":"Token identifying the media bytes that have been uploaded to Google.","type":"string"}}},"photoslibrary_v1_Status":{"description":"The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).","type":"object","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of message types for APIs to use.","type":"array","items":{"type":"object","additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."}}},"message":{"description":"A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.","type":"string"}}},"photoslibrary_v1_TextEnrichment":{"description":"An enrichment containing text.","type":"object","properties":{"text":{"description":"Text for this enrichment item.","type":"string"}}},"photoslibrary_v1_UnshareAlbumRequest":{"description":"Request to unshare a shared album in Google Photos.","type":"object"},"photoslibrary_v1_UnshareAlbumResponse":{"description":"Response of a successful unshare of a shared album.","type":"object"},"photoslibrary_v1_Video":{"description":"Metadata that is specific to a video, for example, fps and processing status. Some of these fields may be null or not included.","type":"object","properties":{"cameraMake":{"description":"Brand of the camera with which the video was taken.","type":"string"},"cameraModel":{"description":"Model of the camera with which the video was taken.","type":"string"},"fps":{"description":"Frame rate of the video.","format":"double","type":"number"},"status":{"description":"Processing status of the video.","enum":["UNSPECIFIED","PROCESSING","READY","FAILED"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/photoslibrary.appendonly":"Add to your Google Photos library","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata":"Edit the info in your photos, videos, and albums created within this app, including titles, descriptions, and covers","https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata":"Manage photos added by this app"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/photoslibrary.appendonly","https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata","https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/photoslibrary/v1/rest","service":"photoslibrary","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-search-console.json b/public/specs/google/google-search-console.json index 29726b2a..efaab313 100644 --- a/public/specs/google/google-search-console.json +++ b/public/specs/google/google-search-console.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Search Console API","version":"v1","description":"The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)"},"servers":[{"url":"https://searchconsole.googleapis.com/"}],"paths":{"/v1/urlInspection/index:inspect":{"post":{"operationId":"searchconsole.urlInspection.index.inspect","x-executor-toolPath":"searchconsole.urlInspection.index.inspect","tags":["Google Search Console API"],"description":"Index inspection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_InspectUrlIndexRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_InspectUrlIndexResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}},"/v1/urlTestingTools/mobileFriendlyTest:run":{"post":{"operationId":"searchconsole.urlTestingTools.mobileFriendlyTest.run","x-executor-toolPath":"searchconsole.urlTestingTools.mobileFriendlyTest.run","tags":["Google Search Console API"],"description":"Runs Mobile-Friendly Test for a given URL.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_RunMobileFriendlyTestRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_RunMobileFriendlyTestResponse"}}}}},"x-google-scopes":[]}},"/webmasters/v3/sites":{"get":{"operationId":"webmasters.sites.list","x-executor-toolPath":"webmasters.sites.list","tags":["Google Search Console API"],"description":"Lists the user's Search Console sites.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SitesListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}":{"get":{"operationId":"webmasters.sites.get","x-executor-toolPath":"webmasters.sites.get","tags":["Google Search Console API"],"description":"Retrieves information about specific site.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","schema":{"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_WmxSite"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]},"put":{"operationId":"webmasters.sites.add","x-executor-toolPath":"webmasters.sites.add","tags":["Google Search Console API"],"description":"Adds a site to the set of the user's sites in Search Console.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The URL of the site to add.","schema":{"description":"The URL of the site to add.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]},"delete":{"operationId":"webmasters.sites.delete","x-executor-toolPath":"webmasters.sites.delete","tags":["Google Search Console API"],"description":"Removes a site from the set of the user's Search Console sites.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","schema":{"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}/searchAnalytics/query":{"post":{"operationId":"webmasters.searchanalytics.query","x-executor-toolPath":"webmasters.searchanalytics.query","tags":["Google Search Console API"],"description":"Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SearchAnalyticsQueryRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SearchAnalyticsQueryResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}/sitemaps":{"get":{"operationId":"webmasters.sitemaps.list","x-executor-toolPath":"webmasters.sitemaps.list","tags":["Google Search Console API"],"description":"Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sitemapIndex","in":"query","required":false,"description":"A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.","schema":{"description":"A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SitemapsListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}":{"get":{"operationId":"webmasters.sitemaps.get","x-executor-toolPath":"webmasters.sitemaps.get","tags":["Google Search Console API"],"description":"Retrieves information about a specific sitemap.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"feedpath","in":"path","required":true,"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","schema":{"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_WmxSitemap"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]},"put":{"operationId":"webmasters.sitemaps.submit","x-executor-toolPath":"webmasters.sitemaps.submit","tags":["Google Search Console API"],"description":"Submits a sitemap for a site.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"feedpath","in":"path","required":true,"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","schema":{"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]},"delete":{"operationId":"webmasters.sitemaps.delete","x-executor-toolPath":"webmasters.sitemaps.delete","tags":["Google Search Console API"],"description":"Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"feedpath","in":"path","required":true,"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","schema":{"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}}},"components":{"schemas":{"searchconsole_v1_AmpInspectionResult":{"description":"AMP inspection result of the live page or the current information from Google's index, depending on whether you requested a live inspection or not.","type":"object","properties":{"ampIndexStatusVerdict":{"description":"Index status of the AMP URL.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"},"ampUrl":{"description":"URL of the AMP that was inspected. If the submitted URL is a desktop page that refers to an AMP version, the AMP version will be inspected.","type":"string"},"indexingState":{"description":"Whether or not the page blocks indexing through a noindex rule.","enum":["AMP_INDEXING_STATE_UNSPECIFIED","AMP_INDEXING_ALLOWED","BLOCKED_DUE_TO_NOINDEX","BLOCKED_DUE_TO_EXPIRED_UNAVAILABLE_AFTER"],"type":"string"},"issues":{"description":"A list of zero or more AMP issues found for the inspected URL.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_AmpIssue"}},"lastCrawlTime":{"description":"Last time this AMP version was crawled by Google. Absent if the URL was never crawled successfully.","format":"google-datetime","type":"string"},"pageFetchState":{"description":"Whether or not Google could fetch the AMP.","enum":["PAGE_FETCH_STATE_UNSPECIFIED","SUCCESSFUL","SOFT_404","BLOCKED_ROBOTS_TXT","NOT_FOUND","ACCESS_DENIED","SERVER_ERROR","REDIRECT_ERROR","ACCESS_FORBIDDEN","BLOCKED_4XX","INTERNAL_CRAWL_ERROR","INVALID_URL"],"type":"string"},"robotsTxtState":{"description":"Whether or not the page is blocked to Google by a robots.txt rule.","enum":["ROBOTS_TXT_STATE_UNSPECIFIED","ALLOWED","DISALLOWED"],"type":"string"},"verdict":{"description":"The status of the most severe error on the page. If a page has both warnings and errors, the page status is error. Error status means the page cannot be shown in Search results.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_AmpIssue":{"description":"AMP issue.","type":"object","properties":{"issueMessage":{"description":"Brief description of this issue.","type":"string"},"severity":{"description":"Severity of this issue: WARNING or ERROR.","enum":["SEVERITY_UNSPECIFIED","WARNING","ERROR"],"type":"string"}}},"searchconsole_v1_ApiDataRow":{"type":"object","properties":{"clicks":{"format":"double","type":"number"},"ctr":{"format":"double","type":"number"},"impressions":{"format":"double","type":"number"},"keys":{"type":"array","items":{"type":"string"}},"position":{"format":"double","type":"number"}}},"searchconsole_v1_ApiDimensionFilter":{"description":"A filter test to be applied to each row in the data set, where a match can return the row. Filters are string comparisons, and values and dimension names are not case-sensitive. Individual filters are either AND'ed or OR'ed within their parent filter group, according to the group's group type. You do not need to group by a specified dimension to filter against it.","type":"object","properties":{"dimension":{"enum":["QUERY","PAGE","COUNTRY","DEVICE","SEARCH_APPEARANCE"],"type":"string"},"expression":{"type":"string"},"operator":{"enum":["EQUALS","NOT_EQUALS","CONTAINS","NOT_CONTAINS","INCLUDING_REGEX","EXCLUDING_REGEX"],"type":"string"}}},"searchconsole_v1_ApiDimensionFilterGroup":{"description":"A set of `dimension` value filters to test against each row. Only rows that pass all filter groups will be returned. All results within a filter group are either AND'ed or OR'ed together, depending on the group type selected. All filter groups are AND'ed together.","type":"object","properties":{"filters":{"description":"Optional. A list of single-value filters in this group.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ApiDimensionFilter"}},"groupType":{"description":"Optional. The logic operator between filters of the same group.","enum":["AND"],"type":"string"}}},"searchconsole_v1_BlockedResource":{"description":"Blocked resource.","type":"object","properties":{"url":{"description":"URL of the blocked resource.","type":"string"}}},"searchconsole_v1_DetectedItems":{"description":"Rich Results items grouped by type.","type":"object","properties":{"items":{"description":"List of Rich Results items.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_Item"}},"richResultType":{"description":"Rich Results type","type":"string"}}},"searchconsole_v1_Image":{"description":"Describe image data.","type":"object","properties":{"data":{"description":"Image data in format determined by the mime type. Currently, the format will always be \"image/png\", but this might change in the future.","format":"byte","type":"string"},"mimeType":{"description":"The mime-type of the image data.","type":"string"}}},"searchconsole_v1_IndexStatusInspectionResult":{"description":"Results of index status inspection for either the live page or the version in Google's index, depending on whether you requested a live inspection or not. For more information, see the [Index coverage report documentation](https://support.google.com/webmasters/answer/7440203).","type":"object","properties":{"coverageState":{"description":"Could Google find and index the page. More details about page indexing appear in 'indexing_state'.","type":"string"},"crawledAs":{"description":"Primary crawler that was used by Google to crawl your site.","enum":["CRAWLING_USER_AGENT_UNSPECIFIED","DESKTOP","MOBILE"],"type":"string"},"googleCanonical":{"description":"The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.","type":"string"},"indexingState":{"description":"Whether or not the page blocks indexing through a noindex rule.","enum":["INDEXING_STATE_UNSPECIFIED","INDEXING_ALLOWED","BLOCKED_BY_META_TAG","BLOCKED_BY_HTTP_HEADER","BLOCKED_BY_ROBOTS_TXT"],"type":"string"},"lastCrawlTime":{"description":"Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.","format":"google-datetime","type":"string"},"pageFetchState":{"description":"Whether or not Google could retrieve the page from your server. Equivalent to [\"page fetch\"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.","enum":["PAGE_FETCH_STATE_UNSPECIFIED","SUCCESSFUL","SOFT_404","BLOCKED_ROBOTS_TXT","NOT_FOUND","ACCESS_DENIED","SERVER_ERROR","REDIRECT_ERROR","ACCESS_FORBIDDEN","BLOCKED_4XX","INTERNAL_CRAWL_ERROR","INVALID_URL"],"type":"string"},"referringUrls":{"description":"URLs that link to the inspected URL, directly and indirectly.","type":"array","items":{"type":"string"}},"robotsTxtState":{"description":"Whether or not the page is blocked to Google by a robots.txt rule.","enum":["ROBOTS_TXT_STATE_UNSPECIFIED","ALLOWED","DISALLOWED"],"type":"string"},"sitemap":{"description":"Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.","type":"array","items":{"type":"string"}},"userCanonical":{"description":"The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent.","type":"string"},"verdict":{"description":"High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_InspectUrlIndexRequest":{"description":"Index inspection request.","type":"object","properties":{"inspectionUrl":{"description":"Required. URL to inspect. Must be under the property specified in \"site_url\".","type":"string"},"languageCode":{"description":"Optional. An [IETF BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language code representing the requested language for translated issue messages, e.g. \"en-US\", \"or \"de-CH\". Default value is \"en-US\".","type":"string"},"siteUrl":{"description":"Required. The URL of the property as defined in Search Console. **Examples:** `http://www.example.com/` for a URL-prefix property, or `sc-domain:example.com` for a Domain property.","type":"string"}}},"searchconsole_v1_InspectUrlIndexResponse":{"description":"Index-Status inspection response.","type":"object","properties":{"inspectionResult":{"$ref":"#/components/schemas/searchconsole_v1_UrlInspectionResult"}}},"searchconsole_v1_Item":{"description":"A specific rich result found on the page.","type":"object","properties":{"issues":{"description":"A list of zero or more rich result issues found for this instance.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_RichResultsIssue"}},"name":{"description":"The user-provided name of this item.","type":"string"}}},"searchconsole_v1_Metadata":{"description":"An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using `all` or `hourly_all` for `dataState`), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the `America/Los_Angeles` time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields.","type":"object","properties":{"firstIncompleteDate":{"description":"The first date for which the data is still being collected and processed, presented in `YYYY-MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is \"`all`\", data is grouped by \"`DATE`\", and the requested date range contains incomplete data points. All values after the `first_incomplete_date` may still change noticeably.","type":"string"},"firstIncompleteHour":{"description":"The first hour for which the data is still being collected and processed, presented in `YYYY-MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is \"`hourly_all`\", data is grouped by \"`HOUR`\" and the requested date range contains incomplete data points. All values after the `first_incomplete_hour` may still change noticeably.","type":"string"}}},"searchconsole_v1_MobileFriendlyIssue":{"description":"Mobile-friendly issue.","type":"object","properties":{"rule":{"description":"Rule violated.","enum":["MOBILE_FRIENDLY_RULE_UNSPECIFIED","USES_INCOMPATIBLE_PLUGINS","CONFIGURE_VIEWPORT","FIXED_WIDTH_VIEWPORT","SIZE_CONTENT_TO_VIEWPORT","USE_LEGIBLE_FONT_SIZES","TAP_TARGETS_TOO_CLOSE"],"type":"string"}}},"searchconsole_v1_MobileUsabilityInspectionResult":{"description":"Mobile-usability inspection results.","type":"object","properties":{"issues":{"description":"A list of zero or more mobile-usability issues detected for this URL.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_MobileUsabilityIssue"}},"verdict":{"description":"High-level mobile-usability inspection result for this URL.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_MobileUsabilityIssue":{"description":"Mobile-usability issue.","type":"object","properties":{"issueType":{"description":"Mobile-usability issue type.","enum":["MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED","USES_INCOMPATIBLE_PLUGINS","CONFIGURE_VIEWPORT","FIXED_WIDTH_VIEWPORT","SIZE_CONTENT_TO_VIEWPORT","USE_LEGIBLE_FONT_SIZES","TAP_TARGETS_TOO_CLOSE"],"type":"string"},"message":{"description":"Additional information regarding the issue.","type":"string"},"severity":{"description":"Not returned; reserved for future use.","enum":["SEVERITY_UNSPECIFIED","WARNING","ERROR"],"type":"string"}}},"searchconsole_v1_ResourceIssue":{"description":"Information about a resource with issue.","type":"object","properties":{"blockedResource":{"$ref":"#/components/schemas/searchconsole_v1_BlockedResource"}}},"searchconsole_v1_RichResultsInspectionResult":{"description":"Rich-Results inspection result, including any rich results found at this URL.","type":"object","properties":{"detectedItems":{"description":"A list of zero or more rich results detected on this page. Rich results that cannot even be parsed due to syntactic issues will not be listed here.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_DetectedItems"}},"verdict":{"description":"High-level rich results inspection result for this URL.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_RichResultsIssue":{"description":"Severity and status of a single issue affecting a single rich result instance on a page.","type":"object","properties":{"issueMessage":{"description":"Rich Results issue type.","type":"string"},"severity":{"description":"Severity of this issue: WARNING, or ERROR. Items with an issue of status ERROR cannot appear with rich result features in Google Search results.","enum":["SEVERITY_UNSPECIFIED","WARNING","ERROR"],"type":"string"}}},"searchconsole_v1_RunMobileFriendlyTestRequest":{"description":"Mobile-friendly test request.","type":"object","properties":{"requestScreenshot":{"description":"Whether or not screenshot is requested. Default is false.","type":"boolean"},"url":{"description":"URL for inspection.","type":"string"}}},"searchconsole_v1_RunMobileFriendlyTestResponse":{"description":"Mobile-friendly test response, including mobile-friendly issues and resource issues.","type":"object","properties":{"mobileFriendliness":{"description":"Test verdict, whether the page is mobile friendly or not.","enum":["MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED","MOBILE_FRIENDLY","NOT_MOBILE_FRIENDLY"],"type":"string"},"mobileFriendlyIssues":{"description":"List of mobile-usability issues.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_MobileFriendlyIssue"}},"resourceIssues":{"description":"Information about embedded resources issues.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ResourceIssue"}},"screenshot":{"$ref":"#/components/schemas/searchconsole_v1_Image"},"testStatus":{"$ref":"#/components/schemas/searchconsole_v1_TestStatus"}}},"searchconsole_v1_SearchAnalyticsQueryRequest":{"type":"object","properties":{"aggregationType":{"description":"[Optional; Default is \\\"auto\\\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. **Note:** If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.","enum":["AUTO","BY_PROPERTY","BY_PAGE","BY_NEWS_SHOWCASE_PANEL"],"type":"string"},"dataState":{"description":"The data state to be fetched, can be full or all, the latter including full and partial data.","enum":["DATA_STATE_UNSPECIFIED","FINAL","ALL","HOURLY_ALL"],"type":"string"},"dimensionFilterGroups":{"description":"[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \\\"buy\\\"' to see only data where the query string contains the substring \\\"buy\\\" (not case-sensitive). You can filter by a dimension without grouping by it.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ApiDimensionFilterGroup"}},"dimensions":{"description":"[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.","type":"array","items":{"enum":["DATE","QUERY","PAGE","COUNTRY","DEVICE","SEARCH_APPEARANCE","HOUR"],"type":"string"}},"endDate":{"description":"[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.","type":"string"},"rowLimit":{"description":"[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 25,000 (inclusive).","format":"int32","type":"integer"},"searchType":{"description":"[Optional; Default is \\\"web\\\"] The search type to filter for.","enum":["WEB","IMAGE","VIDEO","NEWS","DISCOVER","GOOGLE_NEWS"],"type":"string"},"startDate":{"description":" [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.","type":"string"},"startRow":{"description":"[Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.","format":"int32","type":"integer"},"type":{"description":"Optional. [Optional; Default is \\\"web\\\"] Type of report: search type, or either Discover or Gnews.","enum":["WEB","IMAGE","VIDEO","NEWS","DISCOVER","GOOGLE_NEWS"],"type":"string"}}},"searchconsole_v1_SearchAnalyticsQueryResponse":{"description":"A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/searchconsole_v1_Metadata"},"responseAggregationType":{"description":"How the results were aggregated.","enum":["AUTO","BY_PROPERTY","BY_PAGE","BY_NEWS_SHOWCASE_PANEL"],"type":"string"},"rows":{"description":"A list of rows grouped by the key values in the order given in the query.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ApiDataRow"}}}},"searchconsole_v1_SitemapsListResponse":{"description":"List of sitemaps.","type":"object","properties":{"sitemap":{"description":"Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_WmxSitemap"}}}},"searchconsole_v1_SitesListResponse":{"description":"List of sites with access level information.","type":"object","properties":{"siteEntry":{"description":"Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_WmxSite"}}}},"searchconsole_v1_TestStatus":{"description":"Final state of the test, including error details if necessary.","type":"object","properties":{"details":{"description":"Error details if applicable.","type":"string"},"status":{"description":"Status of the test.","enum":["TEST_STATUS_UNSPECIFIED","COMPLETE","INTERNAL_ERROR","PAGE_UNREACHABLE"],"type":"string"}}},"searchconsole_v1_UrlInspectionResult":{"description":"URL inspection result, including all inspection results.","type":"object","properties":{"ampResult":{"$ref":"#/components/schemas/searchconsole_v1_AmpInspectionResult"},"indexStatusResult":{"$ref":"#/components/schemas/searchconsole_v1_IndexStatusInspectionResult"},"inspectionResultLink":{"description":"Link to Search Console URL inspection.","type":"string"},"mobileUsabilityResult":{"$ref":"#/components/schemas/searchconsole_v1_MobileUsabilityInspectionResult"},"richResultsResult":{"$ref":"#/components/schemas/searchconsole_v1_RichResultsInspectionResult"}}},"searchconsole_v1_WmxSite":{"description":"Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).","type":"object","properties":{"permissionLevel":{"description":"The user's permission level for the site.","enum":["SITE_PERMISSION_LEVEL_UNSPECIFIED","SITE_OWNER","SITE_FULL_USER","SITE_RESTRICTED_USER","SITE_UNVERIFIED_USER"],"type":"string"},"siteUrl":{"description":"The URL of the site.","type":"string"}}},"searchconsole_v1_WmxSitemap":{"description":"Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).","type":"object","properties":{"contents":{"description":"The various content types in the sitemap.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_WmxSitemapContent"}},"errors":{"description":"Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.","format":"int64","type":"string"},"isPending":{"description":"If true, the sitemap has not been processed.","type":"boolean"},"isSitemapsIndex":{"description":"If true, the sitemap is a collection of sitemaps.","type":"boolean"},"lastDownloaded":{"description":"Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).","format":"google-datetime","type":"string"},"lastSubmitted":{"description":"Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).","format":"google-datetime","type":"string"},"path":{"description":"The url of the sitemap.","type":"string"},"type":{"description":"The type of the sitemap. For example: `rssFeed`.","enum":["NOT_SITEMAP","URL_LIST","SITEMAP","RSS_FEED","ATOM_FEED","PATTERN_SITEMAP","OCEANFRONT"],"type":"string"},"warnings":{"description":"Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.","format":"int64","type":"string"}}},"searchconsole_v1_WmxSitemapContent":{"description":"Information about the various content types in the sitemap.","type":"object","properties":{"indexed":{"description":"*Deprecated; do not use.*","format":"int64","type":"string"},"submitted":{"description":"The number of URLs in the sitemap (of the content type).","format":"int64","type":"string"},"type":{"description":"The specific type of content in this sitemap. For example: `web`.","enum":["WEB","IMAGE","VIDEO","NEWS","MOBILE","ANDROID_APP","PATTERN","IOS_APP","DATA_FEED_ELEMENT"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/webmasters":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/webmasters"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/searchconsole/v1/rest","service":"searchconsole","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Search Console API","version":"v1","description":"The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)"},"servers":[{"url":"https://searchconsole.googleapis.com/"}],"paths":{"/v1/urlInspection/index:inspect":{"post":{"operationId":"searchconsole.urlInspection.index.inspect","x-executor-toolPath":"searchconsole.urlInspection.index.inspect","tags":["Google Search Console API"],"description":"Index inspection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_InspectUrlIndexRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_InspectUrlIndexResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters.readonly","https://www.googleapis.com/auth/webmasters"]}},"/v1/urlTestingTools/mobileFriendlyTest:run":{"post":{"operationId":"searchconsole.urlTestingTools.mobileFriendlyTest.run","x-executor-toolPath":"searchconsole.urlTestingTools.mobileFriendlyTest.run","tags":["Google Search Console API"],"description":"Runs Mobile-Friendly Test for a given URL.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_RunMobileFriendlyTestRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_RunMobileFriendlyTestResponse"}}}}},"x-google-scopes":[]}},"/webmasters/v3/sites":{"get":{"operationId":"webmasters.sites.list","x-executor-toolPath":"webmasters.sites.list","tags":["Google Search Console API"],"description":"Lists the user's Search Console sites.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SitesListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters.readonly","https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}":{"get":{"operationId":"webmasters.sites.get","x-executor-toolPath":"webmasters.sites.get","tags":["Google Search Console API"],"description":"Retrieves information about specific site.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","schema":{"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_WmxSite"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters.readonly","https://www.googleapis.com/auth/webmasters"]},"put":{"operationId":"webmasters.sites.add","x-executor-toolPath":"webmasters.sites.add","tags":["Google Search Console API"],"description":"Adds a site to the set of the user's sites in Search Console.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The URL of the site to add.","schema":{"description":"The URL of the site to add.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]},"delete":{"operationId":"webmasters.sites.delete","x-executor-toolPath":"webmasters.sites.delete","tags":["Google Search Console API"],"description":"Removes a site from the set of the user's Search Console sites.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","schema":{"description":"The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}/searchAnalytics/query":{"post":{"operationId":"webmasters.searchanalytics.query","x-executor-toolPath":"webmasters.searchanalytics.query","tags":["Google Search Console API"],"description":"Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SearchAnalyticsQueryRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SearchAnalyticsQueryResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters.readonly","https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}/sitemaps":{"get":{"operationId":"webmasters.sitemaps.list","x-executor-toolPath":"webmasters.sitemaps.list","tags":["Google Search Console API"],"description":"Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sitemapIndex","in":"query","required":false,"description":"A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.","schema":{"description":"A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_SitemapsListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters.readonly","https://www.googleapis.com/auth/webmasters"]}},"/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}":{"get":{"operationId":"webmasters.sitemaps.get","x-executor-toolPath":"webmasters.sitemaps.get","tags":["Google Search Console API"],"description":"Retrieves information about a specific sitemap.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"feedpath","in":"path","required":true,"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","schema":{"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/searchconsole_v1_WmxSitemap"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters.readonly","https://www.googleapis.com/auth/webmasters"]},"put":{"operationId":"webmasters.sitemaps.submit","x-executor-toolPath":"webmasters.sitemaps.submit","tags":["Google Search Console API"],"description":"Submits a sitemap for a site.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"feedpath","in":"path","required":true,"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","schema":{"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]},"delete":{"operationId":"webmasters.sitemaps.delete","x-executor-toolPath":"webmasters.sitemaps.delete","tags":["Google Search Console API"],"description":"Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.","parameters":[{"name":"siteUrl","in":"path","required":true,"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","schema":{"description":"The site's URL, including protocol. For example: `http://www.example.com/`.","type":"string"}},{"name":"feedpath","in":"path","required":true,"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","schema":{"description":"The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/webmasters"]}],"x-google-scopes":["https://www.googleapis.com/auth/webmasters"]}}},"components":{"schemas":{"searchconsole_v1_AmpInspectionResult":{"description":"AMP inspection result of the live page or the current information from Google's index, depending on whether you requested a live inspection or not.","type":"object","properties":{"ampIndexStatusVerdict":{"description":"Index status of the AMP URL.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"},"ampUrl":{"description":"URL of the AMP that was inspected. If the submitted URL is a desktop page that refers to an AMP version, the AMP version will be inspected.","type":"string"},"indexingState":{"description":"Whether or not the page blocks indexing through a noindex rule.","enum":["AMP_INDEXING_STATE_UNSPECIFIED","AMP_INDEXING_ALLOWED","BLOCKED_DUE_TO_NOINDEX","BLOCKED_DUE_TO_EXPIRED_UNAVAILABLE_AFTER"],"type":"string"},"issues":{"description":"A list of zero or more AMP issues found for the inspected URL.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_AmpIssue"}},"lastCrawlTime":{"description":"Last time this AMP version was crawled by Google. Absent if the URL was never crawled successfully.","format":"google-datetime","type":"string"},"pageFetchState":{"description":"Whether or not Google could fetch the AMP.","enum":["PAGE_FETCH_STATE_UNSPECIFIED","SUCCESSFUL","SOFT_404","BLOCKED_ROBOTS_TXT","NOT_FOUND","ACCESS_DENIED","SERVER_ERROR","REDIRECT_ERROR","ACCESS_FORBIDDEN","BLOCKED_4XX","INTERNAL_CRAWL_ERROR","INVALID_URL"],"type":"string"},"robotsTxtState":{"description":"Whether or not the page is blocked to Google by a robots.txt rule.","enum":["ROBOTS_TXT_STATE_UNSPECIFIED","ALLOWED","DISALLOWED"],"type":"string"},"verdict":{"description":"The status of the most severe error on the page. If a page has both warnings and errors, the page status is error. Error status means the page cannot be shown in Search results.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_AmpIssue":{"description":"AMP issue.","type":"object","properties":{"issueMessage":{"description":"Brief description of this issue.","type":"string"},"severity":{"description":"Severity of this issue: WARNING or ERROR.","enum":["SEVERITY_UNSPECIFIED","WARNING","ERROR"],"type":"string"}}},"searchconsole_v1_ApiDataRow":{"type":"object","properties":{"clicks":{"format":"double","type":"number"},"ctr":{"format":"double","type":"number"},"impressions":{"format":"double","type":"number"},"keys":{"type":"array","items":{"type":"string"}},"position":{"format":"double","type":"number"}}},"searchconsole_v1_ApiDimensionFilter":{"description":"A filter test to be applied to each row in the data set, where a match can return the row. Filters are string comparisons, and values and dimension names are not case-sensitive. Individual filters are either AND'ed or OR'ed within their parent filter group, according to the group's group type. You do not need to group by a specified dimension to filter against it.","type":"object","properties":{"dimension":{"enum":["QUERY","PAGE","COUNTRY","DEVICE","SEARCH_APPEARANCE"],"type":"string"},"expression":{"type":"string"},"operator":{"enum":["EQUALS","NOT_EQUALS","CONTAINS","NOT_CONTAINS","INCLUDING_REGEX","EXCLUDING_REGEX"],"type":"string"}}},"searchconsole_v1_ApiDimensionFilterGroup":{"description":"A set of `dimension` value filters to test against each row. Only rows that pass all filter groups will be returned. All results within a filter group are either AND'ed or OR'ed together, depending on the group type selected. All filter groups are AND'ed together.","type":"object","properties":{"filters":{"description":"Optional. A list of single-value filters in this group.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ApiDimensionFilter"}},"groupType":{"description":"Optional. The logic operator between filters of the same group.","enum":["AND"],"type":"string"}}},"searchconsole_v1_BlockedResource":{"description":"Blocked resource.","type":"object","properties":{"url":{"description":"URL of the blocked resource.","type":"string"}}},"searchconsole_v1_DetectedItems":{"description":"Rich Results items grouped by type.","type":"object","properties":{"items":{"description":"List of Rich Results items.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_Item"}},"richResultType":{"description":"Rich Results type","type":"string"}}},"searchconsole_v1_Image":{"description":"Describe image data.","type":"object","properties":{"data":{"description":"Image data in format determined by the mime type. Currently, the format will always be \"image/png\", but this might change in the future.","format":"byte","type":"string"},"mimeType":{"description":"The mime-type of the image data.","type":"string"}}},"searchconsole_v1_IndexStatusInspectionResult":{"description":"Results of index status inspection for either the live page or the version in Google's index, depending on whether you requested a live inspection or not. For more information, see the [Index coverage report documentation](https://support.google.com/webmasters/answer/7440203).","type":"object","properties":{"coverageState":{"description":"Could Google find and index the page. More details about page indexing appear in 'indexing_state'.","type":"string"},"crawledAs":{"description":"Primary crawler that was used by Google to crawl your site.","enum":["CRAWLING_USER_AGENT_UNSPECIFIED","DESKTOP","MOBILE"],"type":"string"},"googleCanonical":{"description":"The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.","type":"string"},"indexingState":{"description":"Whether or not the page blocks indexing through a noindex rule.","enum":["INDEXING_STATE_UNSPECIFIED","INDEXING_ALLOWED","BLOCKED_BY_META_TAG","BLOCKED_BY_HTTP_HEADER","BLOCKED_BY_ROBOTS_TXT"],"type":"string"},"lastCrawlTime":{"description":"Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.","format":"google-datetime","type":"string"},"pageFetchState":{"description":"Whether or not Google could retrieve the page from your server. Equivalent to [\"page fetch\"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.","enum":["PAGE_FETCH_STATE_UNSPECIFIED","SUCCESSFUL","SOFT_404","BLOCKED_ROBOTS_TXT","NOT_FOUND","ACCESS_DENIED","SERVER_ERROR","REDIRECT_ERROR","ACCESS_FORBIDDEN","BLOCKED_4XX","INTERNAL_CRAWL_ERROR","INVALID_URL"],"type":"string"},"referringUrls":{"description":"URLs that link to the inspected URL, directly and indirectly.","type":"array","items":{"type":"string"}},"robotsTxtState":{"description":"Whether or not the page is blocked to Google by a robots.txt rule.","enum":["ROBOTS_TXT_STATE_UNSPECIFIED","ALLOWED","DISALLOWED"],"type":"string"},"sitemap":{"description":"Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.","type":"array","items":{"type":"string"}},"userCanonical":{"description":"The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent.","type":"string"},"verdict":{"description":"High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_InspectUrlIndexRequest":{"description":"Index inspection request.","type":"object","properties":{"inspectionUrl":{"description":"Required. URL to inspect. Must be under the property specified in \"site_url\".","type":"string"},"languageCode":{"description":"Optional. An [IETF BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language code representing the requested language for translated issue messages, e.g. \"en-US\", \"or \"de-CH\". Default value is \"en-US\".","type":"string"},"siteUrl":{"description":"Required. The URL of the property as defined in Search Console. **Examples:** `http://www.example.com/` for a URL-prefix property, or `sc-domain:example.com` for a Domain property.","type":"string"}}},"searchconsole_v1_InspectUrlIndexResponse":{"description":"Index-Status inspection response.","type":"object","properties":{"inspectionResult":{"$ref":"#/components/schemas/searchconsole_v1_UrlInspectionResult"}}},"searchconsole_v1_Item":{"description":"A specific rich result found on the page.","type":"object","properties":{"issues":{"description":"A list of zero or more rich result issues found for this instance.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_RichResultsIssue"}},"name":{"description":"The user-provided name of this item.","type":"string"}}},"searchconsole_v1_Metadata":{"description":"An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using `all` or `hourly_all` for `dataState`), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the `America/Los_Angeles` time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields.","type":"object","properties":{"firstIncompleteDate":{"description":"The first date for which the data is still being collected and processed, presented in `YYYY-MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is \"`all`\", data is grouped by \"`DATE`\", and the requested date range contains incomplete data points. All values after the `first_incomplete_date` may still change noticeably.","type":"string"},"firstIncompleteHour":{"description":"The first hour for which the data is still being collected and processed, presented in `YYYY-MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is \"`hourly_all`\", data is grouped by \"`HOUR`\" and the requested date range contains incomplete data points. All values after the `first_incomplete_hour` may still change noticeably.","type":"string"}}},"searchconsole_v1_MobileFriendlyIssue":{"description":"Mobile-friendly issue.","type":"object","properties":{"rule":{"description":"Rule violated.","enum":["MOBILE_FRIENDLY_RULE_UNSPECIFIED","USES_INCOMPATIBLE_PLUGINS","CONFIGURE_VIEWPORT","FIXED_WIDTH_VIEWPORT","SIZE_CONTENT_TO_VIEWPORT","USE_LEGIBLE_FONT_SIZES","TAP_TARGETS_TOO_CLOSE"],"type":"string"}}},"searchconsole_v1_MobileUsabilityInspectionResult":{"description":"Mobile-usability inspection results.","type":"object","properties":{"issues":{"description":"A list of zero or more mobile-usability issues detected for this URL.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_MobileUsabilityIssue"}},"verdict":{"description":"High-level mobile-usability inspection result for this URL.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_MobileUsabilityIssue":{"description":"Mobile-usability issue.","type":"object","properties":{"issueType":{"description":"Mobile-usability issue type.","enum":["MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED","USES_INCOMPATIBLE_PLUGINS","CONFIGURE_VIEWPORT","FIXED_WIDTH_VIEWPORT","SIZE_CONTENT_TO_VIEWPORT","USE_LEGIBLE_FONT_SIZES","TAP_TARGETS_TOO_CLOSE"],"type":"string"},"message":{"description":"Additional information regarding the issue.","type":"string"},"severity":{"description":"Not returned; reserved for future use.","enum":["SEVERITY_UNSPECIFIED","WARNING","ERROR"],"type":"string"}}},"searchconsole_v1_ResourceIssue":{"description":"Information about a resource with issue.","type":"object","properties":{"blockedResource":{"$ref":"#/components/schemas/searchconsole_v1_BlockedResource"}}},"searchconsole_v1_RichResultsInspectionResult":{"description":"Rich-Results inspection result, including any rich results found at this URL.","type":"object","properties":{"detectedItems":{"description":"A list of zero or more rich results detected on this page. Rich results that cannot even be parsed due to syntactic issues will not be listed here.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_DetectedItems"}},"verdict":{"description":"High-level rich results inspection result for this URL.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"],"type":"string"}}},"searchconsole_v1_RichResultsIssue":{"description":"Severity and status of a single issue affecting a single rich result instance on a page.","type":"object","properties":{"issueMessage":{"description":"Rich Results issue type.","type":"string"},"severity":{"description":"Severity of this issue: WARNING, or ERROR. Items with an issue of status ERROR cannot appear with rich result features in Google Search results.","enum":["SEVERITY_UNSPECIFIED","WARNING","ERROR"],"type":"string"}}},"searchconsole_v1_RunMobileFriendlyTestRequest":{"description":"Mobile-friendly test request.","type":"object","properties":{"requestScreenshot":{"description":"Whether or not screenshot is requested. Default is false.","type":"boolean"},"url":{"description":"URL for inspection.","type":"string"}}},"searchconsole_v1_RunMobileFriendlyTestResponse":{"description":"Mobile-friendly test response, including mobile-friendly issues and resource issues.","type":"object","properties":{"mobileFriendliness":{"description":"Test verdict, whether the page is mobile friendly or not.","enum":["MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED","MOBILE_FRIENDLY","NOT_MOBILE_FRIENDLY"],"type":"string"},"mobileFriendlyIssues":{"description":"List of mobile-usability issues.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_MobileFriendlyIssue"}},"resourceIssues":{"description":"Information about embedded resources issues.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ResourceIssue"}},"screenshot":{"$ref":"#/components/schemas/searchconsole_v1_Image"},"testStatus":{"$ref":"#/components/schemas/searchconsole_v1_TestStatus"}}},"searchconsole_v1_SearchAnalyticsQueryRequest":{"type":"object","properties":{"aggregationType":{"description":"[Optional; Default is \\\"auto\\\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. **Note:** If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.","enum":["AUTO","BY_PROPERTY","BY_PAGE","BY_NEWS_SHOWCASE_PANEL"],"type":"string"},"dataState":{"description":"The data state to be fetched, can be full or all, the latter including full and partial data.","enum":["DATA_STATE_UNSPECIFIED","FINAL","ALL","HOURLY_ALL"],"type":"string"},"dimensionFilterGroups":{"description":"[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \\\"buy\\\"' to see only data where the query string contains the substring \\\"buy\\\" (not case-sensitive). You can filter by a dimension without grouping by it.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ApiDimensionFilterGroup"}},"dimensions":{"description":"[Optional] Zero or more dimensions to group results by. Dimensions are the group-by values in the Search Analytics page. Dimensions are combined to create a unique row key for each row. Results are grouped in the order that you supply these dimensions.","type":"array","items":{"enum":["DATE","QUERY","PAGE","COUNTRY","DEVICE","SEARCH_APPEARANCE","HOUR"],"type":"string"}},"endDate":{"description":"[Required] End date of the requested date range, in YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal to the start date. This value is included in the range.","type":"string"},"rowLimit":{"description":"[Optional; Default is 1000] The maximum number of rows to return. Must be a number from 1 to 25,000 (inclusive).","format":"int32","type":"integer"},"searchType":{"description":"[Optional; Default is \\\"web\\\"] The search type to filter for.","enum":["WEB","IMAGE","VIDEO","NEWS","DISCOVER","GOOGLE_NEWS"],"type":"string"},"startDate":{"description":" [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range.","type":"string"},"startRow":{"description":"[Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number.","format":"int32","type":"integer"},"type":{"description":"Optional. [Optional; Default is \\\"web\\\"] Type of report: search type, or either Discover or Gnews.","enum":["WEB","IMAGE","VIDEO","NEWS","DISCOVER","GOOGLE_NEWS"],"type":"string"}}},"searchconsole_v1_SearchAnalyticsQueryResponse":{"description":"A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/searchconsole_v1_Metadata"},"responseAggregationType":{"description":"How the results were aggregated.","enum":["AUTO","BY_PROPERTY","BY_PAGE","BY_NEWS_SHOWCASE_PANEL"],"type":"string"},"rows":{"description":"A list of rows grouped by the key values in the order given in the query.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_ApiDataRow"}}}},"searchconsole_v1_SitemapsListResponse":{"description":"List of sitemaps.","type":"object","properties":{"sitemap":{"description":"Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_WmxSitemap"}}}},"searchconsole_v1_SitesListResponse":{"description":"List of sites with access level information.","type":"object","properties":{"siteEntry":{"description":"Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_WmxSite"}}}},"searchconsole_v1_TestStatus":{"description":"Final state of the test, including error details if necessary.","type":"object","properties":{"details":{"description":"Error details if applicable.","type":"string"},"status":{"description":"Status of the test.","enum":["TEST_STATUS_UNSPECIFIED","COMPLETE","INTERNAL_ERROR","PAGE_UNREACHABLE"],"type":"string"}}},"searchconsole_v1_UrlInspectionResult":{"description":"URL inspection result, including all inspection results.","type":"object","properties":{"ampResult":{"$ref":"#/components/schemas/searchconsole_v1_AmpInspectionResult"},"indexStatusResult":{"$ref":"#/components/schemas/searchconsole_v1_IndexStatusInspectionResult"},"inspectionResultLink":{"description":"Link to Search Console URL inspection.","type":"string"},"mobileUsabilityResult":{"$ref":"#/components/schemas/searchconsole_v1_MobileUsabilityInspectionResult"},"richResultsResult":{"$ref":"#/components/schemas/searchconsole_v1_RichResultsInspectionResult"}}},"searchconsole_v1_WmxSite":{"description":"Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).","type":"object","properties":{"permissionLevel":{"description":"The user's permission level for the site.","enum":["SITE_PERMISSION_LEVEL_UNSPECIFIED","SITE_OWNER","SITE_FULL_USER","SITE_RESTRICTED_USER","SITE_UNVERIFIED_USER"],"type":"string"},"siteUrl":{"description":"The URL of the site.","type":"string"}}},"searchconsole_v1_WmxSitemap":{"description":"Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).","type":"object","properties":{"contents":{"description":"The various content types in the sitemap.","type":"array","items":{"$ref":"#/components/schemas/searchconsole_v1_WmxSitemapContent"}},"errors":{"description":"Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.","format":"int64","type":"string"},"isPending":{"description":"If true, the sitemap has not been processed.","type":"boolean"},"isSitemapsIndex":{"description":"If true, the sitemap is a collection of sitemaps.","type":"boolean"},"lastDownloaded":{"description":"Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).","format":"google-datetime","type":"string"},"lastSubmitted":{"description":"Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).","format":"google-datetime","type":"string"},"path":{"description":"The url of the sitemap.","type":"string"},"type":{"description":"The type of the sitemap. For example: `rssFeed`.","enum":["NOT_SITEMAP","URL_LIST","SITEMAP","RSS_FEED","ATOM_FEED","PATTERN_SITEMAP","OCEANFRONT"],"type":"string"},"warnings":{"description":"Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.","format":"int64","type":"string"}}},"searchconsole_v1_WmxSitemapContent":{"description":"Information about the various content types in the sitemap.","type":"object","properties":{"indexed":{"description":"*Deprecated; do not use.*","format":"int64","type":"string"},"submitted":{"description":"The number of URLs in the sitemap (of the content type).","format":"int64","type":"string"},"type":{"description":"The specific type of content in this sitemap. For example: `web`.","enum":["WEB","IMAGE","VIDEO","NEWS","MOBILE","ANDROID_APP","PATTERN","IOS_APP","DATA_FEED_ELEMENT"],"type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/webmasters":"View and manage Search Console data for your verified sites","https://www.googleapis.com/auth/webmasters.readonly":"View Search Console data for your verified sites"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/webmasters"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/searchconsole/v1/rest","service":"searchconsole","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-sheets.json b/public/specs/google/google-sheets.json index c8b56fde..debd0fc5 100644 --- a/public/specs/google/google-sheets.json +++ b/public/specs/google/google-sheets.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Sheets API","version":"v4","description":"Reads and writes Google Sheets."},"servers":[{"url":"https://sheets.googleapis.com/"}],"paths":{"/v4/spreadsheets":{"post":{"operationId":"sheets.spreadsheets.create","x-executor-toolPath":"sheets.spreadsheets.create","tags":["Google Sheets API"],"description":"Creates a spreadsheet, returning the newly created spreadsheet.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}":{"get":{"operationId":"sheets.spreadsheets.get","x-executor-toolPath":"sheets.spreadsheets.get","tags":["Google Sheets API"],"description":"Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The spreadsheet to request.","schema":{"description":"The spreadsheet to request.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [Developer Preview](https://developers.google.com/workspace/preview).","schema":{"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"excludeTablesInBandedRanges","in":"query","required":false,"description":"True if tables should be excluded in the banded ranges. False if not set.","schema":{"description":"True if tables should be excluded in the banded ranges. False if not set.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeGridData","in":"query","required":false,"description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request.","schema":{"description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"ranges","in":"query","required":false,"description":"The ranges to retrieve from the spreadsheet.","schema":{"type":"array","items":{"description":"The ranges to retrieve from the spreadsheet.","type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}":{"get":{"operationId":"sheets.spreadsheets.developerMetadata.get","x-executor-toolPath":"sheets.spreadsheets.developerMetadata.get","tags":["Google Sheets API"],"description":"Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve metadata from.","schema":{"description":"The ID of the spreadsheet to retrieve metadata from.","type":"string"}},{"name":"metadataId","in":"path","required":true,"description":"The ID of the developer metadata to retrieve.","schema":{"description":"The ID of the developer metadata to retrieve.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/developerMetadata:search":{"post":{"operationId":"sheets.spreadsheets.developerMetadata.search","x-executor-toolPath":"sheets.spreadsheets.developerMetadata.search","tags":["Google Sheets API"],"description":"Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve metadata from.","schema":{"description":"The ID of the spreadsheet to retrieve metadata from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_SearchDeveloperMetadataRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_SearchDeveloperMetadataResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo":{"post":{"operationId":"sheets.spreadsheets.sheets.copyTo","x-executor-toolPath":"sheets.spreadsheets.sheets.copyTo","tags":["Google Sheets API"],"description":"Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet containing the sheet to copy.","schema":{"description":"The ID of the spreadsheet containing the sheet to copy.","type":"string"}},{"name":"sheetId","in":"path","required":true,"description":"The ID of the sheet to copy.","schema":{"description":"The ID of the sheet to copy.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_CopySheetToAnotherSpreadsheetRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}":{"get":{"operationId":"sheets.spreadsheets.values.get","x-executor-toolPath":"sheets.spreadsheets.values.get","tags":["Google Sheets API"],"description":"Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve data from.","schema":{"description":"The ID of the spreadsheet to retrieve data from.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","schema":{"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"dateTimeRenderOption","in":"query","required":false,"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"majorDimension","in":"query","required":false,"description":"The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","schema":{"description":"The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueRenderOption","in":"query","required":false,"description":"How values should be represented in the output. The default render option is FORMATTED_VALUE.","schema":{"description":"How values should be represented in the output. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]},"put":{"operationId":"sheets.spreadsheets.values.update","x-executor-toolPath":"sheets.spreadsheets.values.update","tags":["Google Sheets API"],"description":"Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update.","schema":{"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeValuesInResponse","in":"query","required":false,"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","schema":{"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"responseDateTimeRenderOption","in":"query","required":false,"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"responseValueRenderOption","in":"query","required":false,"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","schema":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueInputOption","in":"query","required":false,"description":"How the input data should be interpreted.","schema":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}:append":{"post":{"operationId":"sheets.spreadsheets.values.append","x-executor-toolPath":"sheets.spreadsheets.values.append","tags":["Google Sheets API"],"description":"Appends values to a spreadsheet. The input range is used to search for existing data and find a \"table\" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.","schema":{"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeValuesInResponse","in":"query","required":false,"description":"Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.","schema":{"description":"Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.","type":"boolean"},"style":"form","explode":false},{"name":"insertDataOption","in":"query","required":false,"description":"How the input data should be inserted.","schema":{"description":"How the input data should be inserted.","enum":["OVERWRITE","INSERT_ROWS"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"responseDateTimeRenderOption","in":"query","required":false,"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"responseValueRenderOption","in":"query","required":false,"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","schema":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueInputOption","in":"query","required":false,"description":"How the input data should be interpreted.","schema":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_AppendValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}:clear":{"post":{"operationId":"sheets.spreadsheets.values.clear","x-executor-toolPath":"sheets.spreadsheets.values.clear","tags":["Google Sheets API"],"description":"Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear.","schema":{"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ClearValuesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ClearValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchClear":{"post":{"operationId":"sheets.spreadsheets.values.batchClear","x-executor-toolPath":"sheets.spreadsheets.values.batchClear","tags":["Google Sheets API"],"description":"Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter":{"post":{"operationId":"sheets.spreadsheets.values.batchClearByDataFilter","x-executor-toolPath":"sheets.spreadsheets.values.batchClearByDataFilter","tags":["Google Sheets API"],"description":"Clears one or more ranges of values from a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesByDataFilterResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchGet":{"get":{"operationId":"sheets.spreadsheets.values.batchGet","x-executor-toolPath":"sheets.spreadsheets.values.batchGet","tags":["Google Sheets API"],"description":"Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve data from.","schema":{"description":"The ID of the spreadsheet to retrieve data from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"dateTimeRenderOption","in":"query","required":false,"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"majorDimension","in":"query","required":false,"description":"The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","schema":{"description":"The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"ranges","in":"query","required":false,"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","schema":{"type":"array","items":{"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueRenderOption","in":"query","required":false,"description":"How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.","schema":{"description":"How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchGetValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter":{"post":{"operationId":"sheets.spreadsheets.values.batchGetByDataFilter","x-executor-toolPath":"sheets.spreadsheets.values.batchGetByDataFilter","tags":["Google Sheets API"],"description":"Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve data from.","schema":{"description":"The ID of the spreadsheet to retrieve data from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchGetValuesByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchGetValuesByDataFilterResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchUpdate":{"post":{"operationId":"sheets.spreadsheets.values.batchUpdate","x-executor-toolPath":"sheets.spreadsheets.values.batchUpdate","tags":["Google Sheets API"],"description":"Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter":{"post":{"operationId":"sheets.spreadsheets.values.batchUpdateByDataFilter","x-executor-toolPath":"sheets.spreadsheets.values.batchUpdateByDataFilter","tags":["Google Sheets API"],"description":"Sets values in one or more ranges of a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesByDataFilterResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}:batchUpdate":{"post":{"operationId":"sheets.spreadsheets.batchUpdate","x-executor-toolPath":"sheets.spreadsheets.batchUpdate","tags":["Google Sheets API"],"description":"Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The spreadsheet to apply the updates to.","schema":{"description":"The spreadsheet to apply the updates to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateSpreadsheetRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateSpreadsheetResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}:getByDataFilter":{"post":{"operationId":"sheets.spreadsheets.getByDataFilter","x-executor-toolPath":"sheets.spreadsheets.getByDataFilter","tags":["Google Sheets API"],"description":"Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP. * Set the includeGridData parameter to `true`. If a field mask is set, the `includeGridData` parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The spreadsheet to request.","schema":{"description":"The spreadsheet to request.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_GetSpreadsheetByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}}},"components":{"schemas":{"sheets_v4_AddBandingRequest":{"description":"Adds a new banded range to the spreadsheet.","type":"object","properties":{"bandedRange":{"$ref":"#/components/schemas/sheets_v4_BandedRange"}}},"sheets_v4_AddBandingResponse":{"description":"The result of adding a banded range.","type":"object","properties":{"bandedRange":{"$ref":"#/components/schemas/sheets_v4_BandedRange"}}},"sheets_v4_AddChartRequest":{"description":"Adds a chart to a sheet in the spreadsheet.","type":"object","properties":{"chart":{"$ref":"#/components/schemas/sheets_v4_EmbeddedChart"}}},"sheets_v4_AddChartResponse":{"description":"The result of adding a chart to a spreadsheet.","type":"object","properties":{"chart":{"$ref":"#/components/schemas/sheets_v4_EmbeddedChart"}}},"sheets_v4_AddCommentReplyRequest":{"description":"Inserts a reply Post into a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread to add the reply to.","type":"string"},"post":{"$ref":"#/components/schemas/sheets_v4_Post"}}},"sheets_v4_AddCommentReplyResponse":{"description":"The result of creating a reply. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"post":{"$ref":"#/components/schemas/sheets_v4_Post"}}},"sheets_v4_AddConditionalFormatRuleRequest":{"description":"Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented.","type":"object","properties":{"index":{"description":"The zero-based index where the rule should be inserted.","format":"int32","type":"integer"},"rule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}}},"sheets_v4_AddDataSourceRequest":{"description":"Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source.","type":"object","properties":{"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"}}},"sheets_v4_AddDataSourceResponse":{"description":"The result of adding a data source.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"}}},"sheets_v4_AddDimensionGroupRequest":{"description":"Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2].","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_AddDimensionGroupResponse":{"description":"The result of adding a group.","type":"object","properties":{"dimensionGroups":{"description":"All groups of a dimension after adding a group to that dimension.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}}}},"sheets_v4_AddFilterViewRequest":{"description":"Adds a filter view.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_AddFilterViewResponse":{"description":"The result of adding a filter view.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_AddNamedRangeRequest":{"description":"Adds a named range to the spreadsheet.","type":"object","properties":{"namedRange":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}}},"sheets_v4_AddNamedRangeResponse":{"description":"The result of adding a named range.","type":"object","properties":{"namedRange":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}}},"sheets_v4_AddProtectedRangeRequest":{"description":"Adds a new protected range.","type":"object","properties":{"protectedRange":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}}},"sheets_v4_AddProtectedRangeResponse":{"description":"The result of adding a new protected range.","type":"object","properties":{"protectedRange":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}}},"sheets_v4_AddSheetRequest":{"description":"Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_AddSheetResponse":{"description":"The result of adding a sheet.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_AddSlicerRequest":{"description":"Adds a slicer to a sheet in the spreadsheet.","type":"object","properties":{"slicer":{"$ref":"#/components/schemas/sheets_v4_Slicer"}}},"sheets_v4_AddSlicerResponse":{"description":"The result of adding a slicer to a spreadsheet.","type":"object","properties":{"slicer":{"$ref":"#/components/schemas/sheets_v4_Slicer"}}},"sheets_v4_AddTableRequest":{"description":"Adds a new table to the spreadsheet.","type":"object","properties":{"table":{"$ref":"#/components/schemas/sheets_v4_Table"}}},"sheets_v4_AddTableResponse":{"description":"The result of adding a table.","type":"object","properties":{"table":{"$ref":"#/components/schemas/sheets_v4_Table"}}},"sheets_v4_AppendCellsRequest":{"description":"Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.","type":"object","properties":{"fields":{"description":"The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"rows":{"description":"The data to append.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RowData"}},"sheetId":{"description":"The sheet ID to append the data to.","format":"int32","type":"integer"},"tableId":{"description":"The ID of the table to append data to. The data will be only appended to the table body. This field also takes precedence over the `sheet_id` field.","type":"string"}}},"sheets_v4_AppendDimensionRequest":{"description":"Appends rows or columns to the end of a sheet.","type":"object","properties":{"dimension":{"description":"Whether rows or columns should be appended.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"length":{"description":"The number of rows or columns to append.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet to append rows or columns to.","format":"int32","type":"integer"}}},"sheets_v4_AppendValuesResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"tableRange":{"description":"The range (in A1 notation) of the table that values are being appended to (before the values were appended). Empty if no table was found.","type":"string"},"updates":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesResponse"}}},"sheets_v4_AutoFillRequest":{"description":"Fills in more data based on existing data.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sourceAndDestination":{"$ref":"#/components/schemas/sheets_v4_SourceAndDestination"},"useAlternateSeries":{"description":"True if we should generate data with the \"alternate\" series. This differs based on the type and amount of source data.","type":"boolean"}}},"sheets_v4_AutoResizeDimensionsRequest":{"description":"Automatically resizes one or more dimensions based on the contents of the cells in that dimension.","type":"object","properties":{"dataSourceSheetDimensions":{"$ref":"#/components/schemas/sheets_v4_DataSourceSheetDimensionRange"},"dimensions":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_BandedRange":{"description":"A banded (alternating colors) range in a sheet.","type":"object","properties":{"bandedRangeId":{"description":"The ID of the banded range. If unset, refer to banded_range_reference.","format":"int32","type":"integer"},"bandedRangeReference":{"description":"Output only. The reference of the banded range, used to identify the ID that is not supported by the banded_range_id.","readOnly":true,"type":"string"},"columnProperties":{"$ref":"#/components/schemas/sheets_v4_BandingProperties"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rowProperties":{"$ref":"#/components/schemas/sheets_v4_BandingProperties"}}},"sheets_v4_BandingProperties":{"description":"Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.","type":"object","properties":{"firstBandColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"firstBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"footerColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"footerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"headerColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"headerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"secondBandColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"secondBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_BaselineValueFormat":{"description":"Formatting options for baseline value.","type":"object","properties":{"comparisonType":{"description":"The comparison type of key value with baseline value.","enum":["COMPARISON_TYPE_UNDEFINED","ABSOLUTE_DIFFERENCE","PERCENTAGE_DIFFERENCE"],"type":"string"},"description":{"description":"Description which is appended after the baseline value. This field is optional.","type":"string"},"negativeColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"negativeColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"position":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"positiveColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"positiveColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"}}},"sheets_v4_BasicChartAxis":{"description":"An axis of the chart. A chart may not have more than one axis per axis position.","type":"object","properties":{"format":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"position":{"description":"The position of this axis.","enum":["BASIC_CHART_AXIS_POSITION_UNSPECIFIED","BOTTOM_AXIS","LEFT_AXIS","RIGHT_AXIS"],"type":"string"},"title":{"description":"The title of this axis. If set, this overrides any title inferred from headers of the data.","type":"string"},"titleTextPosition":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"viewWindowOptions":{"$ref":"#/components/schemas/sheets_v4_ChartAxisViewWindowOptions"}}},"sheets_v4_BasicChartDomain":{"description":"The domain of a chart. For example, if charting stock prices over time, this would be the date.","type":"object","properties":{"domain":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"reversed":{"description":"True to reverse the order of the domain values (horizontal axis).","type":"boolean"}}},"sheets_v4_BasicChartSeries":{"description":"A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"dataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"},"lineStyle":{"$ref":"#/components/schemas/sheets_v4_LineStyle"},"pointStyle":{"$ref":"#/components/schemas/sheets_v4_PointStyle"},"series":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"styleOverrides":{"description":"Style override settings for series data points.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicSeriesDataPointStyleOverride"}},"targetAxis":{"description":"The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the \"Volume\" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type.","enum":["BASIC_CHART_AXIS_POSITION_UNSPECIFIED","BOTTOM_AXIS","LEFT_AXIS","RIGHT_AXIS"],"type":"string"},"type":{"description":"The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.","enum":["BASIC_CHART_TYPE_UNSPECIFIED","BAR","LINE","AREA","COLUMN","SCATTER","COMBO","STEPPED_AREA"],"type":"string"}}},"sheets_v4_BasicChartSpec":{"description":"The specification for a basic chart. See BasicChartType for the list of charts this supports.","type":"object","properties":{"axis":{"description":"The axis on the chart.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicChartAxis"}},"chartType":{"description":"The type of the chart.","enum":["BASIC_CHART_TYPE_UNSPECIFIED","BAR","LINE","AREA","COLUMN","SCATTER","COMBO","STEPPED_AREA"],"type":"string"},"compareMode":{"description":"The behavior of tooltips and data highlighting when hovering on data and chart area.","enum":["BASIC_CHART_COMPARE_MODE_UNSPECIFIED","DATUM","CATEGORY"],"type":"string"},"domains":{"description":"The domain of data this is charting. Only a single domain is supported.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicChartDomain"}},"headerCount":{"description":"The number of rows or columns in the data that are \"headers\". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.)","format":"int32","type":"integer"},"interpolateNulls":{"description":"If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.","type":"boolean"},"legendPosition":{"description":"The position of the chart legend.","enum":["BASIC_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND"],"type":"string"},"lineSmoothing":{"description":"Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.","type":"boolean"},"series":{"description":"The data this chart is visualizing.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicChartSeries"}},"stackedType":{"description":"The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.","enum":["BASIC_CHART_STACKED_TYPE_UNSPECIFIED","NOT_STACKED","STACKED","PERCENT_STACKED"],"type":"string"},"threeDimensional":{"description":"True to make the chart 3D. Applies to Bar and Column charts.","type":"boolean"},"totalDataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"}}},"sheets_v4_BasicFilter":{"description":"The default filter associated with a sheet. For more information, see [Manage data visibility with filters](https://developers.google.com/workspace/sheets/api/guides/filters).","type":"object","properties":{"criteria":{"description":"The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.","type":"object","additionalProperties":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"}},"filterSpecs":{"description":"The filter criteria per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sortSpecs":{"description":"The sort order per column. Later specifications are used when values are equal in the earlier specifications.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}},"tableId":{"description":"The table this filter is backed by, if any. When writing, only one of range or table_id may be set.","type":"string"}}},"sheets_v4_BasicSeriesDataPointStyleOverride":{"description":"Style override settings for a single series data point.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"index":{"description":"The zero-based index of the series data point.","format":"int32","type":"integer"},"pointStyle":{"$ref":"#/components/schemas/sheets_v4_PointStyle"}}},"sheets_v4_BatchClearValuesByDataFilterRequest":{"description":"The request for clearing more than one range selected by a DataFilter in a spreadsheet.","type":"object","properties":{"dataFilters":{"description":"The DataFilters used to determine which ranges to clear.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}}}},"sheets_v4_BatchClearValuesByDataFilterResponse":{"description":"The response when clearing a range of values selected with DataFilters in a spreadsheet.","type":"object","properties":{"clearedRanges":{"description":"The ranges that were cleared, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a range larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.","type":"array","items":{"type":"string"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"}}},"sheets_v4_BatchClearValuesRequest":{"description":"The request for clearing more than one range of values in a spreadsheet.","type":"object","properties":{"ranges":{"description":"The ranges to clear, in [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell).","type":"array","items":{"type":"string"}}}},"sheets_v4_BatchClearValuesResponse":{"description":"The response when clearing a range of values in a spreadsheet.","type":"object","properties":{"clearedRanges":{"description":"The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a range larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.","type":"array","items":{"type":"string"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"}}},"sheets_v4_BatchGetValuesByDataFilterRequest":{"description":"The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.","type":"object","properties":{"dataFilters":{"description":"The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"dateTimeRenderOption":{"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"majorDimension":{"description":"The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"valueRenderOption":{"description":"How values should be represented in the output. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"}}},"sheets_v4_BatchGetValuesByDataFilterResponse":{"description":"The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.","type":"object","properties":{"spreadsheetId":{"description":"The ID of the spreadsheet the data was retrieved from.","type":"string"},"valueRanges":{"description":"The requested values with the list of data filters that matched them.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_MatchedValueRange"}}}},"sheets_v4_BatchGetValuesResponse":{"description":"The response when retrieving more than one range of values in a spreadsheet.","type":"object","properties":{"spreadsheetId":{"description":"The ID of the spreadsheet the data was retrieved from.","type":"string"},"valueRanges":{"description":"The requested values. The order of the ValueRanges is the same as the order of the requested ranges.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}},"sheets_v4_BatchUpdateSpreadsheetRequest":{"description":"The request for updating any aspect of a spreadsheet.","type":"object","properties":{"commentsViewMode":{"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. Meaningful only if include_spreadsheet_in_response is 'true'. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"includeSpreadsheetInResponse":{"description":"Determines if the update response should include the spreadsheet resource.","type":"boolean"},"requests":{"description":"A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Request"}},"responseIncludeGridData":{"description":"True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.","type":"boolean"},"responseRanges":{"description":"Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.","type":"array","items":{"type":"string"}}}},"sheets_v4_BatchUpdateSpreadsheetResponse":{"description":"The reply for batch updating a spreadsheet.","type":"object","properties":{"commentUpdateState":{"description":"Whether comment updates were applied in the batch request. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENT_UPDATE_STATE_UNSPECIFIED","NO_UPDATES_REQUESTED","ALL_SAVED","ALL_FAILED_UNKNOWN_REASON"],"type":"string"},"replies":{"description":"The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Response"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"updatedSpreadsheet":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}},"sheets_v4_BatchUpdateValuesByDataFilterRequest":{"description":"The request for updating more than one range of values in a spreadsheet.","type":"object","properties":{"data":{"description":"The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilterValueRange"}},"includeValuesInResponse":{"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","type":"boolean"},"responseDateTimeRenderOption":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"responseValueRenderOption":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"valueInputOption":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"}}},"sheets_v4_BatchUpdateValuesByDataFilterResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"responses":{"description":"The response for each range updated.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesByDataFilterResponse"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"totalUpdatedCells":{"description":"The total number of cells updated.","format":"int32","type":"integer"},"totalUpdatedColumns":{"description":"The total number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"totalUpdatedRows":{"description":"The total number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"},"totalUpdatedSheets":{"description":"The total number of sheets where at least one cell in the sheet was updated.","format":"int32","type":"integer"}}},"sheets_v4_BatchUpdateValuesRequest":{"description":"The request for updating more than one range of values in a spreadsheet.","type":"object","properties":{"data":{"description":"The new values to apply to the spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}},"includeValuesInResponse":{"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","type":"boolean"},"responseDateTimeRenderOption":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"responseValueRenderOption":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"valueInputOption":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"}}},"sheets_v4_BatchUpdateValuesResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"responses":{"description":"One UpdateValuesResponse per requested range, in the same order as the requests appeared.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesResponse"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"totalUpdatedCells":{"description":"The total number of cells updated.","format":"int32","type":"integer"},"totalUpdatedColumns":{"description":"The total number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"totalUpdatedRows":{"description":"The total number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"},"totalUpdatedSheets":{"description":"The total number of sheets where at least one cell in the sheet was updated.","format":"int32","type":"integer"}}},"sheets_v4_BigQueryDataSourceSpec":{"description":"The specification of a BigQuery data source that's connected to a sheet.","type":"object","properties":{"projectId":{"description":"The ID of a BigQuery enabled Google Cloud project with a billing account attached. For any queries executed against the data source, the project is charged.","type":"string"},"querySpec":{"$ref":"#/components/schemas/sheets_v4_BigQueryQuerySpec"},"tableSpec":{"$ref":"#/components/schemas/sheets_v4_BigQueryTableSpec"}}},"sheets_v4_BigQueryQuerySpec":{"description":"Specifies a custom BigQuery query.","type":"object","properties":{"rawQuery":{"description":"The raw query string.","type":"string"}}},"sheets_v4_BigQueryTableSpec":{"description":"Specifies a BigQuery table definition. Only [native tables](https://cloud.google.com/bigquery/docs/tables-intro) are allowed.","type":"object","properties":{"datasetId":{"description":"The BigQuery dataset id.","type":"string"},"tableId":{"description":"The BigQuery table id.","type":"string"},"tableProjectId":{"description":"The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed.","type":"string"}}},"sheets_v4_BooleanCondition":{"description":"A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.","type":"object","properties":{"type":{"description":"The type of condition.","enum":["CONDITION_TYPE_UNSPECIFIED","NUMBER_GREATER","NUMBER_GREATER_THAN_EQ","NUMBER_LESS","NUMBER_LESS_THAN_EQ","NUMBER_EQ","NUMBER_NOT_EQ","NUMBER_BETWEEN","NUMBER_NOT_BETWEEN","TEXT_CONTAINS","TEXT_NOT_CONTAINS","TEXT_STARTS_WITH","TEXT_ENDS_WITH","TEXT_EQ","TEXT_IS_EMAIL","TEXT_IS_URL","DATE_EQ","DATE_BEFORE","DATE_AFTER","DATE_ON_OR_BEFORE","DATE_ON_OR_AFTER","DATE_BETWEEN","DATE_NOT_BETWEEN","DATE_IS_VALID","ONE_OF_RANGE","ONE_OF_LIST","BLANK","NOT_BLANK","CUSTOM_FORMULA","BOOLEAN","TEXT_NOT_EQ","DATE_NOT_EQ","FILTER_EXPRESSION"],"type":"string"},"values":{"description":"The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ConditionValue"}}}},"sheets_v4_BooleanRule":{"description":"A rule that may or may not match, depending on the condition.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"format":{"$ref":"#/components/schemas/sheets_v4_CellFormat"}}},"sheets_v4_Border":{"description":"A border along a cell.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"style":{"description":"The style of the border.","enum":["STYLE_UNSPECIFIED","DOTTED","DASHED","SOLID","SOLID_MEDIUM","SOLID_THICK","NONE","DOUBLE"],"type":"string"},"width":{"description":"The width of the border, in pixels. Deprecated; the width is determined by the \"style\" field.","format":"int32","type":"integer"}}},"sheets_v4_Borders":{"description":"The borders of the cell.","type":"object","properties":{"bottom":{"$ref":"#/components/schemas/sheets_v4_Border"},"left":{"$ref":"#/components/schemas/sheets_v4_Border"},"right":{"$ref":"#/components/schemas/sheets_v4_Border"},"top":{"$ref":"#/components/schemas/sheets_v4_Border"}}},"sheets_v4_BubbleChartSpec":{"description":"A bubble chart.","type":"object","properties":{"bubbleBorderColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"bubbleBorderColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"bubbleLabels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"bubbleMaxRadiusSize":{"description":"The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.","format":"int32","type":"integer"},"bubbleMinRadiusSize":{"description":"The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.","format":"int32","type":"integer"},"bubbleOpacity":{"description":"The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.","format":"float","type":"number"},"bubbleSizes":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"bubbleTextStyle":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"domain":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"groupIds":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"legendPosition":{"description":"Where the legend of the chart should be drawn.","enum":["BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND","INSIDE_LEGEND"],"type":"string"},"series":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_CancelDataSourceRefreshRequest":{"description":"Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.","type":"object","properties":{"dataSourceId":{"description":"Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source.","type":"string"},"isAll":{"description":"Cancels all existing data source object refreshes for all data sources in the spreadsheet.","type":"boolean"},"references":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReferences"}}},"sheets_v4_CancelDataSourceRefreshResponse":{"description":"The response from cancelling one or multiple data source object refreshes.","type":"object","properties":{"statuses":{"description":"The cancellation statuses of refreshes of all data source objects specified in the request. If is_all is specified, the field contains only those in failure status. Refreshing and canceling refresh the same data source object is also not allowed in the same `batchUpdate`.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CancelDataSourceRefreshStatus"}}}},"sheets_v4_CancelDataSourceRefreshStatus":{"description":"The status of cancelling a single data source object refresh.","type":"object","properties":{"reference":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReference"},"refreshCancellationStatus":{"$ref":"#/components/schemas/sheets_v4_RefreshCancellationStatus"}}},"sheets_v4_CandlestickChartSpec":{"description":"A candlestick chart.","type":"object","properties":{"data":{"description":"The Candlestick chart data. Only one CandlestickData is supported.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CandlestickData"}},"domain":{"$ref":"#/components/schemas/sheets_v4_CandlestickDomain"}}},"sheets_v4_CandlestickData":{"description":"The Candlestick chart data, each containing the low, open, close, and high values for a series.","type":"object","properties":{"closeSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"},"highSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"},"lowSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"},"openSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"}}},"sheets_v4_CandlestickDomain":{"description":"The domain of a CandlestickChart.","type":"object","properties":{"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"reversed":{"description":"True to reverse the order of the domain values (horizontal axis).","type":"boolean"}}},"sheets_v4_CandlestickSeries":{"description":"The series of a CandlestickData.","type":"object","properties":{"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_CellData":{"description":"Data about a specific cell.","type":"object","properties":{"chipRuns":{"description":"Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty Chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ChipRun"}},"dataSourceFormula":{"$ref":"#/components/schemas/sheets_v4_DataSourceFormula"},"dataSourceTable":{"$ref":"#/components/schemas/sheets_v4_DataSourceTable"},"dataValidation":{"$ref":"#/components/schemas/sheets_v4_DataValidationRule"},"effectiveFormat":{"$ref":"#/components/schemas/sheets_v4_CellFormat"},"effectiveValue":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"},"formattedValue":{"description":"The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.","type":"string"},"hyperlink":{"description":"A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field. A cell-level link can also be set from the userEnteredFormat.textFormat field. Alternatively, set a hyperlink in the textFormatRun.format.link field that spans the entire cell.","type":"string"},"note":{"description":"Any note on the cell.","type":"string"},"pivotTable":{"$ref":"#/components/schemas/sheets_v4_PivotTable"},"textFormatRuns":{"description":"Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of the cell unless explicitly changed. When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_TextFormatRun"}},"userEnteredFormat":{"$ref":"#/components/schemas/sheets_v4_CellFormat"},"userEnteredValue":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}}},"sheets_v4_CellFormat":{"description":"The format of a cell.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"borders":{"$ref":"#/components/schemas/sheets_v4_Borders"},"horizontalAlignment":{"description":"The horizontal alignment of the value in the cell.","enum":["HORIZONTAL_ALIGN_UNSPECIFIED","LEFT","CENTER","RIGHT"],"type":"string"},"hyperlinkDisplayType":{"description":"If one exists, how a hyperlink should be displayed in the cell.","enum":["HYPERLINK_DISPLAY_TYPE_UNSPECIFIED","LINKED","PLAIN_TEXT"],"type":"string"},"numberFormat":{"$ref":"#/components/schemas/sheets_v4_NumberFormat"},"padding":{"$ref":"#/components/schemas/sheets_v4_Padding"},"textDirection":{"description":"The direction of the text in the cell.","enum":["TEXT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"textRotation":{"$ref":"#/components/schemas/sheets_v4_TextRotation"},"verticalAlignment":{"description":"The vertical alignment of the value in the cell.","enum":["VERTICAL_ALIGN_UNSPECIFIED","TOP","MIDDLE","BOTTOM"],"type":"string"},"wrapStrategy":{"description":"The wrap strategy for the value in the cell.","enum":["WRAP_STRATEGY_UNSPECIFIED","OVERFLOW_CELL","LEGACY_WRAP","CLIP","WRAP"],"type":"string"}}},"sheets_v4_ChartAxisViewWindowOptions":{"description":"The options that define a \"view window\" for a chart (such as the visible values in an axis).","type":"object","properties":{"viewWindowMax":{"description":"The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data.","format":"double","type":"number"},"viewWindowMin":{"description":"The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data.","format":"double","type":"number"},"viewWindowMode":{"description":"The view window's mode.","enum":["DEFAULT_VIEW_WINDOW_MODE","VIEW_WINDOW_MODE_UNSUPPORTED","EXPLICIT","PRETTY"],"type":"string"}}},"sheets_v4_ChartCustomNumberFormatOptions":{"description":"Custom number formatting options for chart attributes.","type":"object","properties":{"prefix":{"description":"Custom prefix to be prepended to the chart attribute. This field is optional.","type":"string"},"suffix":{"description":"Custom suffix to be appended to the chart attribute. This field is optional.","type":"string"}}},"sheets_v4_ChartData":{"description":"The data included in a domain or series.","type":"object","properties":{"aggregateType":{"description":"The aggregation type for the series of a data source chart. Only supported for data source charts.","enum":["CHART_AGGREGATE_TYPE_UNSPECIFIED","AVERAGE","COUNT","MAX","MEDIAN","MIN","SUM"],"type":"string"},"columnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"groupRule":{"$ref":"#/components/schemas/sheets_v4_ChartGroupRule"},"sourceRange":{"$ref":"#/components/schemas/sheets_v4_ChartSourceRange"}}},"sheets_v4_ChartDateTimeRule":{"description":"Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.","type":"object","properties":{"type":{"description":"The type of date-time grouping to apply.","enum":["CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED","SECOND","MINUTE","HOUR","HOUR_MINUTE","HOUR_MINUTE_AMPM","DAY_OF_WEEK","DAY_OF_YEAR","DAY_OF_MONTH","DAY_MONTH","MONTH","QUARTER","YEAR","YEAR_MONTH","YEAR_QUARTER","YEAR_MONTH_DAY"],"type":"string"}}},"sheets_v4_ChartGroupRule":{"description":"An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value. For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregate_type.","type":"object","properties":{"dateTimeRule":{"$ref":"#/components/schemas/sheets_v4_ChartDateTimeRule"},"histogramRule":{"$ref":"#/components/schemas/sheets_v4_ChartHistogramRule"}}},"sheets_v4_ChartHistogramRule":{"description":"Allows you to organize numeric values in a source data column into buckets of constant size.","type":"object","properties":{"intervalSize":{"description":"The size of the buckets that are created. Must be positive.","format":"double","type":"number"},"maxValue":{"description":"The maximum value at which items are placed into buckets. Values greater than the maximum are grouped into a single bucket. If omitted, it is determined by the maximum item value.","format":"double","type":"number"},"minValue":{"description":"The minimum value at which items are placed into buckets. Values that are less than the minimum are grouped into a single bucket. If omitted, it is determined by the minimum item value.","format":"double","type":"number"}}},"sheets_v4_ChartSourceRange":{"description":"Source ranges for a chart.","type":"object","properties":{"sources":{"description":"The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more than one source range, then the source range at a given offset must be in order and contiguous across the domain and series. For example, these are valid configurations: domain sources: A1:A5 series1 sources: B1:B5 series2 sources: D6:D10 domain sources: A1:A5, C10:C12 series1 sources: B1:B5, D10:D12 series2 sources: C1:C5, E10:E12","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}}},"sheets_v4_ChartSpec":{"description":"The specifications of a chart.","type":"object","properties":{"altText":{"description":"The alternative text that describes the chart. This is often used for accessibility.","type":"string"},"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"basicChart":{"$ref":"#/components/schemas/sheets_v4_BasicChartSpec"},"bubbleChart":{"$ref":"#/components/schemas/sheets_v4_BubbleChartSpec"},"candlestickChart":{"$ref":"#/components/schemas/sheets_v4_CandlestickChartSpec"},"dataSourceChartProperties":{"$ref":"#/components/schemas/sheets_v4_DataSourceChartProperties"},"filterSpecs":{"description":"The filters applied to the source data of the chart. Only supported for data source charts.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"fontName":{"description":"The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.","type":"string"},"hiddenDimensionStrategy":{"description":"Determines how the charts will use hidden rows or columns.","enum":["CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED","SKIP_HIDDEN_ROWS_AND_COLUMNS","SKIP_HIDDEN_ROWS","SKIP_HIDDEN_COLUMNS","SHOW_ALL"],"type":"string"},"histogramChart":{"$ref":"#/components/schemas/sheets_v4_HistogramChartSpec"},"maximized":{"description":"True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)","type":"boolean"},"orgChart":{"$ref":"#/components/schemas/sheets_v4_OrgChartSpec"},"pieChart":{"$ref":"#/components/schemas/sheets_v4_PieChartSpec"},"scorecardChart":{"$ref":"#/components/schemas/sheets_v4_ScorecardChartSpec"},"sortSpecs":{"description":"The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}},"subtitle":{"description":"The subtitle of the chart.","type":"string"},"subtitleTextFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"subtitleTextPosition":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"title":{"description":"The title of the chart.","type":"string"},"titleTextFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"titleTextPosition":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"treemapChart":{"$ref":"#/components/schemas/sheets_v4_TreemapChartSpec"},"waterfallChart":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartSpec"}}},"sheets_v4_Chip":{"description":"The Smart Chip.","type":"object","properties":{"personProperties":{"$ref":"#/components/schemas/sheets_v4_PersonProperties"},"richLinkProperties":{"$ref":"#/components/schemas/sheets_v4_RichLinkProperties"}}},"sheets_v4_ChipRun":{"description":"The run of a chip. The chip continues until the start index of the next run.","type":"object","properties":{"chip":{"$ref":"#/components/schemas/sheets_v4_Chip"},"startIndex":{"description":"Required. The zero-based character index where this run starts, in UTF-16 code units.","format":"int32","type":"integer"}}},"sheets_v4_ClearBasicFilterRequest":{"description":"Clears the basic filter, if any exists on the sheet.","type":"object","properties":{"sheetId":{"description":"The sheet ID on which the basic filter should be cleared.","format":"int32","type":"integer"}}},"sheets_v4_ClearValuesRequest":{"description":"The request for clearing a range of values in a spreadsheet.","type":"object"},"sheets_v4_ClearValuesResponse":{"description":"The response when clearing a range of values in a spreadsheet.","type":"object","properties":{"clearedRange":{"description":"The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a range larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet's limits.)","type":"string"},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"}}},"sheets_v4_Color":{"description":"Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...","type":"object","properties":{"alpha":{"description":"The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).","format":"float","type":"number"},"blue":{"description":"The amount of blue in the color as a value in the interval [0, 1].","format":"float","type":"number"},"green":{"description":"The amount of green in the color as a value in the interval [0, 1].","format":"float","type":"number"},"red":{"description":"The amount of red in the color as a value in the interval [0, 1].","format":"float","type":"number"}}},"sheets_v4_ColorStyle":{"description":"A color value.","type":"object","properties":{"rgbColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"themeColor":{"description":"Theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","TEXT","BACKGROUND","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","LINK"],"type":"string"}}},"sheets_v4_CommentAnchor":{"description":"A location in the spreadsheet that is tied to a CommentThread with the same anchorId. Note: Multiple anchors may refer to the same location. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"The unique ID of the comment anchor. Output only.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_CommentThread":{"description":"Represents a single comment thread inside a spreadsheet. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"The ID of the CommentAnchor in the sheet that this thread is tied to.","type":"string"},"commentId":{"description":"The unique ID of the comment thread.","type":"string"},"headPost":{"$ref":"#/components/schemas/sheets_v4_Post"},"plainTextQuote":{"description":"The quoted text from the spreadsheet when the comment was created, formatted as plain-text.","type":"string"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Post"}},"status":{"description":"Whether the thread is open or resolved.","enum":["STATUS_UNSPECIFIED","OPEN","RESOLVED"],"type":"string"}}},"sheets_v4_ConditionValue":{"description":"The value of the condition.","type":"object","properties":{"relativeDate":{"description":"A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters.","enum":["RELATIVE_DATE_UNSPECIFIED","PAST_YEAR","PAST_MONTH","PAST_WEEK","YESTERDAY","TODAY","TOMORROW"],"type":"string"},"userEnteredValue":{"description":"A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+').","type":"string"}}},"sheets_v4_ConditionalFormatRule":{"description":"A rule describing a conditional format.","type":"object","properties":{"booleanRule":{"$ref":"#/components/schemas/sheets_v4_BooleanRule"},"gradientRule":{"$ref":"#/components/schemas/sheets_v4_GradientRule"},"ranges":{"description":"The ranges that are formatted if the condition is true. All the ranges must be on the same grid.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}}},"sheets_v4_CopyPasteRequest":{"description":"Copies data from the source to the destination.","type":"object","properties":{"destination":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"pasteOrientation":{"description":"How that data should be oriented when pasting.","enum":["NORMAL","TRANSPOSE"],"type":"string"},"pasteType":{"description":"What kind of data to paste.","enum":["PASTE_NORMAL","PASTE_VALUES","PASTE_FORMAT","PASTE_NO_BORDERS","PASTE_FORMULA","PASTE_DATA_VALIDATION","PASTE_CONDITIONAL_FORMATTING"],"type":"string"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_CopySheetToAnotherSpreadsheetRequest":{"description":"The request to copy a sheet across spreadsheets.","type":"object","properties":{"destinationSpreadsheetId":{"description":"The ID of the spreadsheet to copy the sheet to.","type":"string"}}},"sheets_v4_CreateDeveloperMetadataRequest":{"description":"A request to create developer metadata.","type":"object","properties":{"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}},"sheets_v4_CreateDeveloperMetadataResponse":{"description":"The response from creating developer metadata.","type":"object","properties":{"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}},"sheets_v4_CutPasteRequest":{"description":"Moves data from the source to the destination.","type":"object","properties":{"destination":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"pasteType":{"description":"What kind of data to paste. All the source data will be cut, regardless of what is pasted.","enum":["PASTE_NORMAL","PASTE_VALUES","PASTE_FORMAT","PASTE_NO_BORDERS","PASTE_FORMULA","PASTE_DATA_VALIDATION","PASTE_CONDITIONAL_FORMATTING"],"type":"string"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DataExecutionStatus":{"description":"The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects.","type":"object","properties":{"errorCode":{"description":"The error code.","enum":["DATA_EXECUTION_ERROR_CODE_UNSPECIFIED","TIMED_OUT","TOO_MANY_ROWS","TOO_MANY_COLUMNS","TOO_MANY_CELLS","ENGINE","PARAMETER_INVALID","UNSUPPORTED_DATA_TYPE","DUPLICATE_COLUMN_NAMES","INTERRUPTED","CONCURRENT_QUERY","OTHER","TOO_MANY_CHARS_PER_CELL","DATA_NOT_FOUND","PERMISSION_DENIED","MISSING_COLUMN_ALIAS","OBJECT_NOT_FOUND","OBJECT_IN_ERROR_STATE","OBJECT_SPEC_INVALID","DATA_EXECUTION_CANCELLED"],"type":"string"},"errorMessage":{"description":"The error message, which may be empty.","type":"string"},"lastRefreshTime":{"description":"Gets the time the data last successfully refreshed.","format":"google-datetime","type":"string"},"state":{"description":"The state of the data execution.","enum":["DATA_EXECUTION_STATE_UNSPECIFIED","NOT_STARTED","RUNNING","CANCELLING","SUCCEEDED","FAILED"],"type":"string"}}},"sheets_v4_DataFilter":{"description":"Filter that describes what data should be selected or returned from a request. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).","type":"object","properties":{"a1Range":{"description":"Selects data that matches the specified A1 range.","type":"string"},"developerMetadataLookup":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadataLookup"},"gridRange":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DataFilterValueRange":{"description":"A range of values whose location is specified by a DataFilter.","type":"object","properties":{"dataFilter":{"$ref":"#/components/schemas/sheets_v4_DataFilter"},"majorDimension":{"description":"The major dimension of the values.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"values":{"description":"The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request fails. If the provided values are less than the matched ranges only the specified values are written, existing values in the matched ranges remain unaffected.","type":"array","items":{"type":"array","items":{}}}}},"sheets_v4_DataLabel":{"description":"Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.","type":"object","properties":{"customLabelData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"placement":{"description":"The placement of the data label relative to the labeled data.","enum":["DATA_LABEL_PLACEMENT_UNSPECIFIED","CENTER","LEFT","RIGHT","ABOVE","BELOW","INSIDE_END","INSIDE_BASE","OUTSIDE_END"],"type":"string"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"type":{"description":"The type of the data label.","enum":["DATA_LABEL_TYPE_UNSPECIFIED","NONE","DATA","CUSTOM"],"type":"string"}}},"sheets_v4_DataSource":{"description":"Information about an external data source in the spreadsheet.","type":"object","properties":{"calculatedColumns":{"description":"All calculated columns in the data source.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumn"}},"dataSourceId":{"description":"The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365.","type":"string"},"sheetId":{"description":"The ID of the Sheet connected with the data source. The field cannot be changed once set. When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_DataSourceSpec"}}},"sheets_v4_DataSourceChartProperties":{"description":"Properties of a data source chart.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"ID of the data source that the chart is associated with.","type":"string"}}},"sheets_v4_DataSourceColumn":{"description":"A column in a data source.","type":"object","properties":{"formula":{"description":"The formula of the calculated column.","type":"string"},"reference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"}}},"sheets_v4_DataSourceColumnReference":{"description":"An unique identifier that references a data source column.","type":"object","properties":{"name":{"description":"The display name of the column. It should be unique within a data source.","type":"string"}}},"sheets_v4_DataSourceFormula":{"description":"A data source formula.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"The ID of the data source the formula is associated with.","type":"string"}}},"sheets_v4_DataSourceObjectReference":{"description":"Reference to a data source object.","type":"object","properties":{"chartId":{"description":"References to a data source chart.","format":"int32","type":"integer"},"dataSourceFormulaCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"dataSourcePivotTableAnchorCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"dataSourceTableAnchorCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"sheetId":{"description":"References to a DATA_SOURCE sheet.","type":"string"}}},"sheets_v4_DataSourceObjectReferences":{"description":"A list of references to data source objects.","type":"object","properties":{"references":{"description":"The references.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReference"}}}},"sheets_v4_DataSourceParameter":{"description":"A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.","type":"object","properties":{"name":{"description":"Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers).","type":"string"},"namedRangeId":{"description":"ID of a NamedRange. Its size must be 1x1.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DataSourceRefreshDailySchedule":{"description":"A schedule for data to refresh every day in a given time interval.","type":"object","properties":{"startTime":{"$ref":"#/components/schemas/sheets_v4_TimeOfDay"}}},"sheets_v4_DataSourceRefreshMonthlySchedule":{"description":"A monthly schedule for data to refresh on specific days in the month in a given time interval.","type":"object","properties":{"daysOfMonth":{"description":"Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At least one day must be specified.","type":"array","items":{"format":"int32","type":"integer"}},"startTime":{"$ref":"#/components/schemas/sheets_v4_TimeOfDay"}}},"sheets_v4_DataSourceRefreshSchedule":{"description":"Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day.","type":"object","properties":{"dailySchedule":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshDailySchedule"},"enabled":{"description":"True if the refresh schedule is enabled, or false otherwise.","type":"boolean"},"monthlySchedule":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshMonthlySchedule"},"nextRun":{"$ref":"#/components/schemas/sheets_v4_Interval"},"refreshScope":{"description":"The scope of the refresh. Must be ALL_DATA_SOURCES.","enum":["DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED","ALL_DATA_SOURCES"],"type":"string"},"weeklySchedule":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshWeeklySchedule"}}},"sheets_v4_DataSourceRefreshWeeklySchedule":{"description":"A weekly schedule for data to refresh on specific days in a given time interval.","type":"object","properties":{"daysOfWeek":{"description":"Days of the week to refresh. At least one day must be specified.","type":"array","items":{"enum":["DAY_OF_WEEK_UNSPECIFIED","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"}},"startTime":{"$ref":"#/components/schemas/sheets_v4_TimeOfDay"}}},"sheets_v4_DataSourceSheetDimensionRange":{"description":"A range along a single dimension on a DATA_SOURCE sheet.","type":"object","properties":{"columnReferences":{"description":"The columns on the data source sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"}},"sheetId":{"description":"The ID of the data source sheet the range is on.","format":"int32","type":"integer"}}},"sheets_v4_DataSourceSheetProperties":{"description":"Additional properties of a DATA_SOURCE sheet.","type":"object","properties":{"columns":{"description":"The columns displayed on the sheet, corresponding to the values in RowData.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumn"}},"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"ID of the DataSource the sheet is connected to.","type":"string"}}},"sheets_v4_DataSourceSpec":{"description":"This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.","type":"object","properties":{"bigQuery":{"$ref":"#/components/schemas/sheets_v4_BigQueryDataSourceSpec"},"looker":{"$ref":"#/components/schemas/sheets_v4_LookerDataSourceSpec"},"parameters":{"description":"The parameters of the data source, used when querying the data source.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceParameter"}}}},"sheets_v4_DataSourceTable":{"description":"A data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as \"Extract\" in the Sheets editor.","type":"object","properties":{"columnSelectionType":{"description":"The type to select columns for the data source table. Defaults to SELECTED.","enum":["DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED","SELECTED","SYNC_ALL"],"type":"string"},"columns":{"description":"Columns selected for the data source table. The column_selection_type must be SELECTED.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"}},"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"The ID of the data source the data source table is associated with.","type":"string"},"filterSpecs":{"description":"Filter specifications in the data source table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"rowLimit":{"description":"The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit.","format":"int32","type":"integer"},"sortSpecs":{"description":"Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}}}},"sheets_v4_DataValidationRule":{"description":"A data validation rule.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"inputMessage":{"description":"A message to show the user when adding data to the cell.","type":"string"},"showCustomUi":{"description":"True if the UI should be customized based on the kind of condition. If true, \"List\" conditions will show a dropdown.","type":"boolean"},"strict":{"description":"True if invalid data should be rejected.","type":"boolean"}}},"sheets_v4_DateTimeRule":{"description":"Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+--------------+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +--------------+--------------+ | Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +--------------+--------------+","type":"object","properties":{"type":{"description":"The type of date-time grouping to apply.","enum":["DATE_TIME_RULE_TYPE_UNSPECIFIED","SECOND","MINUTE","HOUR","HOUR_MINUTE","HOUR_MINUTE_AMPM","DAY_OF_WEEK","DAY_OF_YEAR","DAY_OF_MONTH","DAY_MONTH","MONTH","QUARTER","YEAR","YEAR_MONTH","YEAR_QUARTER","YEAR_MONTH_DAY"],"type":"string"}}},"sheets_v4_DeleteBandingRequest":{"description":"Removes the banded range with the given ID from the spreadsheet.","type":"object","properties":{"bandedRangeId":{"description":"The ID of the banded range to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteCommentReplyRequest":{"description":"Deletes a reply Post from a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains a comment action. - The reply post contains an assignee. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"postId":{"description":"The ID of the reply Post being deleted.","type":"string"}}},"sheets_v4_DeleteCommentRequest":{"description":"Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread that is being deleted.","type":"string"}}},"sheets_v4_DeleteConditionalFormatRuleRequest":{"description":"Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented.","type":"object","properties":{"index":{"description":"The zero-based index of the rule to be deleted.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet the rule is being deleted from.","format":"int32","type":"integer"}}},"sheets_v4_DeleteConditionalFormatRuleResponse":{"description":"The result of deleting a conditional format rule.","type":"object","properties":{"rule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}}},"sheets_v4_DeleteDataSourceRequest":{"description":"Deletes a data source. The request also deletes the associated data source sheet, and unlinks all associated data source objects.","type":"object","properties":{"dataSourceId":{"description":"The ID of the data source to delete.","type":"string"}}},"sheets_v4_DeleteDeveloperMetadataRequest":{"description":"A request to delete developer metadata.","type":"object","properties":{"dataFilter":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}}},"sheets_v4_DeleteDeveloperMetadataResponse":{"description":"The response from deleting developer metadata.","type":"object","properties":{"deletedDeveloperMetadata":{"description":"The metadata that was deleted.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}}},"sheets_v4_DeleteDimensionGroupRequest":{"description":"Deletes a group over the specified range by decrementing the depth of the dimensions in the range. For example, assume the sheet has a depth-1 group over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the sheet with a depth-1 group over B:D and a depth-2 group over C:C.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_DeleteDimensionGroupResponse":{"description":"The result of deleting a group.","type":"object","properties":{"dimensionGroups":{"description":"All groups of a dimension after deleting a group from that dimension.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}}}},"sheets_v4_DeleteDimensionRequest":{"description":" Deletes the dimensions from the sheet.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_DeleteDuplicatesRequest":{"description":"Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. Rows with identical values but different letter cases, formatting, or formulas are considered to be duplicates. This request also removes duplicate rows hidden from view (for example, due to a filter). When removing duplicates, the first instance of each duplicate row scanning from the top downwards is kept in the resulting range. Content outside of the specified range isn't removed, and rows considered duplicates do not have to be adjacent to each other in the range.","type":"object","properties":{"comparisonColumns":{"description":"The columns in the range to analyze for duplicate values. If no columns are selected then all columns are analyzed for duplicates.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DeleteDuplicatesResponse":{"description":"The result of removing duplicates in a range.","type":"object","properties":{"duplicatesRemovedCount":{"description":"The number of duplicate rows removed.","format":"int32","type":"integer"}}},"sheets_v4_DeleteEmbeddedObjectRequest":{"description":"Deletes the embedded object with the given ID.","type":"object","properties":{"objectId":{"description":"The ID of the embedded object to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteFilterViewRequest":{"description":"Deletes a particular filter view.","type":"object","properties":{"filterId":{"description":"The ID of the filter to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteNamedRangeRequest":{"description":"Removes the named range with the given ID from the spreadsheet.","type":"object","properties":{"namedRangeId":{"description":"The ID of the named range to delete.","type":"string"}}},"sheets_v4_DeleteProtectedRangeRequest":{"description":"Deletes the protected range with the given ID.","type":"object","properties":{"protectedRangeId":{"description":"The ID of the protected range to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteRangeRequest":{"description":"Deletes a range of cells, shifting other cells into the deleted area.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"shiftDimension":{"description":"The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"}}},"sheets_v4_DeleteSheetRequest":{"description":"Deletes the requested sheet.","type":"object","properties":{"sheetId":{"description":"The ID of the sheet to delete. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted.","format":"int32","type":"integer"}}},"sheets_v4_DeleteTableRequest":{"description":"Removes the table with the given ID from the spreadsheet.","type":"object","properties":{"tableId":{"description":"The ID of the table to delete.","type":"string"}}},"sheets_v4_DeveloperMetadata":{"description":"Developer metadata associated with a location or object in a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and it will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata is still associated with the row it was first associated with (what is now row 6). If the associated object is deleted then its metadata is deleted too.","type":"object","properties":{"location":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadataLocation"},"metadataId":{"description":"The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.","format":"int32","type":"integer"},"metadataKey":{"description":"The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.","type":"string"},"metadataValue":{"description":"Data associated with the metadata's key.","type":"string"},"visibility":{"description":"The metadata visibility. Developer metadata must always have visibility specified.","enum":["DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED","DOCUMENT","PROJECT"],"type":"string"}}},"sheets_v4_DeveloperMetadataLocation":{"description":"A location where metadata may be associated in a spreadsheet.","type":"object","properties":{"dimensionRange":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"},"locationType":{"description":"The type of location this object represents. This field is read-only.","enum":["DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED","ROW","COLUMN","SHEET","SPREADSHEET"],"type":"string"},"sheetId":{"description":"The ID of the sheet when metadata is associated with an entire sheet.","format":"int32","type":"integer"},"spreadsheet":{"description":"True when metadata is associated with an entire spreadsheet.","type":"boolean"}}},"sheets_v4_DeveloperMetadataLookup":{"description":"Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that match the intersection of all the specified fields; any field or combination of fields may be specified.","type":"object","properties":{"locationMatchingStrategy":{"description":"Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.","enum":["DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED","EXACT_LOCATION","INTERSECTING_LOCATION"],"type":"string"},"locationType":{"description":"Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location. Spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.","enum":["DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED","ROW","COLUMN","SHEET","SPREADSHEET"],"type":"string"},"metadataId":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.","format":"int32","type":"integer"},"metadataKey":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.","type":"string"},"metadataLocation":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadataLocation"},"metadataValue":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.","type":"string"},"visibility":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visible to the requesting project is considered.","enum":["DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED","DOCUMENT","PROJECT"],"type":"string"}}},"sheets_v4_DimensionGroup":{"description":"A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.","type":"object","properties":{"collapsed":{"description":"This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false.","type":"boolean"},"depth":{"description":"The depth of the group, representing how many groups have a range that wholly contains the range of this group.","format":"int32","type":"integer"},"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_DimensionProperties":{"description":"Properties about a dimension.","type":"object","properties":{"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"developerMetadata":{"description":"The developer metadata associated with a single row or column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}},"hiddenByFilter":{"description":"True if this dimension is being filtered. This field is read-only.","type":"boolean"},"hiddenByUser":{"description":"True if this dimension is explicitly hidden.","type":"boolean"},"pixelSize":{"description":"The height (if a row) or width (if a column) of the dimension in pixels.","format":"int32","type":"integer"}}},"sheets_v4_DimensionRange":{"description":"A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.","type":"object","properties":{"dimension":{"description":"The dimension of the span.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"endIndex":{"description":"The end (exclusive) of the span, or not set if unbounded.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet this span is on.","format":"int32","type":"integer"},"startIndex":{"description":"The start (inclusive) of the span, or not set if unbounded.","format":"int32","type":"integer"}}},"sheets_v4_DuplicateFilterViewRequest":{"description":"Duplicates a particular filter view.","type":"object","properties":{"filterId":{"description":"The ID of the filter being duplicated.","format":"int32","type":"integer"}}},"sheets_v4_DuplicateFilterViewResponse":{"description":"The result of a filter view being duplicated.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_DuplicateSheetRequest":{"description":"Duplicates the contents of a sheet.","type":"object","properties":{"insertSheetIndex":{"description":"The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented.","format":"int32","type":"integer"},"newSheetId":{"description":"If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative.","format":"int32","type":"integer"},"newSheetName":{"description":"The name of the new sheet. If empty, a new name is chosen for you.","type":"string"},"sourceSheetId":{"description":"The sheet to duplicate. If the source sheet is of DATA_SOURCE type, its backing DataSource is also duplicated and associated with the new copy of the sheet. No data execution is triggered, the grid data of this sheet is also copied over but only available after the batch request completes.","format":"int32","type":"integer"}}},"sheets_v4_DuplicateSheetResponse":{"description":"The result of duplicating a sheet.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_Editors":{"description":"The editors of a protected range.","type":"object","properties":{"domainUsersCanEdit":{"description":"True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain.","type":"boolean"},"groups":{"description":"The email addresses of groups with edit access to the protected range.","type":"array","items":{"type":"string"}},"users":{"description":"The email addresses of users with edit access to the protected range.","type":"array","items":{"type":"string"}}}},"sheets_v4_EmbeddedChart":{"description":"A chart embedded in a sheet.","type":"object","properties":{"border":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectBorder"},"chartId":{"description":"The ID of the chart.","format":"int32","type":"integer"},"position":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"},"spec":{"$ref":"#/components/schemas/sheets_v4_ChartSpec"}}},"sheets_v4_EmbeddedObjectBorder":{"description":"A border along an embedded object.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_EmbeddedObjectPosition":{"description":"The position of an embedded object such as a chart.","type":"object","properties":{"newSheet":{"description":"If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.","type":"boolean"},"overlayPosition":{"$ref":"#/components/schemas/sheets_v4_OverlayPosition"},"sheetId":{"description":"The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.","format":"int32","type":"integer"}}},"sheets_v4_ErrorValue":{"description":"An error in a cell.","type":"object","properties":{"message":{"description":"A message with more information about the error (in the spreadsheet's locale).","type":"string"},"type":{"description":"The type of error.","enum":["ERROR_TYPE_UNSPECIFIED","ERROR","NULL_VALUE","DIVIDE_BY_ZERO","VALUE","REF","NAME","NUM","N_A","LOADING"],"type":"string"}}},"sheets_v4_ExtendedValue":{"description":"The kinds of value that a cell in a spreadsheet can have.","type":"object","properties":{"boolValue":{"description":"Represents a boolean value.","type":"boolean"},"errorValue":{"$ref":"#/components/schemas/sheets_v4_ErrorValue"},"formulaValue":{"description":"Represents a formula.","type":"string"},"numberValue":{"description":"Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.","format":"double","type":"number"},"stringValue":{"description":"Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `\"123\"`.","type":"string"}}},"sheets_v4_FilterCriteria":{"description":"Criteria for showing or hiding rows in a filter or filter view.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"hiddenValues":{"description":"Values that should be hidden.","type":"array","items":{"type":"string"}},"visibleBackgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"visibleBackgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"visibleForegroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"visibleForegroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_FilterSpec":{"description":"The filter criteria associated with a specific column.","type":"object","properties":{"columnIndex":{"description":"The zero-based column index.","format":"int32","type":"integer"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"filterCriteria":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"}}},"sheets_v4_FilterView":{"description":"A filter view. For more information, see [Manage data visibility with filters](https://developers.google.com/workspace/sheets/api/guides/filters).","type":"object","properties":{"criteria":{"description":"The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.","type":"object","additionalProperties":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"}},"filterSpecs":{"description":"The filter criteria for showing or hiding values per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"filterViewId":{"description":"The ID of the filter view.","format":"int32","type":"integer"},"namedRangeId":{"description":"The named range this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sortSpecs":{"description":"The sort order per column. Later specifications are used when values are equal in the earlier specifications.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}},"tableId":{"description":"The table this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.","type":"string"},"title":{"description":"The name of the filter view.","type":"string"}}},"sheets_v4_FindReplaceRequest":{"description":"Finds and replaces data in cells over a range, sheet, or all sheets.","type":"object","properties":{"allSheets":{"description":"True to find/replace over all sheets.","type":"boolean"},"find":{"description":"The value to search.","type":"string"},"includeFormulas":{"description":"True if the search should include cells with formulas. False to skip cells with formulas.","type":"boolean"},"matchCase":{"description":"True if the search is case sensitive.","type":"boolean"},"matchEntireCell":{"description":"True if the find value should match the entire cell.","type":"boolean"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"replacement":{"description":"The value to use as the replacement.","type":"string"},"searchByRegex":{"description":"True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents `\"Google Sheets\"` and another has `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of `\"$1 Rocks\"` would change the contents of the cells to `\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.","type":"boolean"},"sheetId":{"description":"The sheet to find/replace over.","format":"int32","type":"integer"}}},"sheets_v4_FindReplaceResponse":{"description":"The result of the find/replace.","type":"object","properties":{"formulasChanged":{"description":"The number of formula cells changed.","format":"int32","type":"integer"},"occurrencesChanged":{"description":"The number of occurrences (possibly multiple within a cell) changed. For example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would be `\"3\"` because `\"Google Sheets\"` -> `\"Googlo Shoots\"`.","format":"int32","type":"integer"},"rowsChanged":{"description":"The number of rows changed.","format":"int32","type":"integer"},"sheetsChanged":{"description":"The number of sheets changed.","format":"int32","type":"integer"},"valuesChanged":{"description":"The number of non-formula cells changed.","format":"int32","type":"integer"}}},"sheets_v4_GetSpreadsheetByDataFilterRequest":{"description":"The request for retrieving a Spreadsheet.","type":"object","properties":{"commentsViewMode":{"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"dataFilters":{"description":"The DataFilters used to select which ranges to retrieve from the spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"excludeTablesInBandedRanges":{"description":"True if tables should be excluded in the banded ranges. False if not set.","type":"boolean"},"includeGridData":{"description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request.","type":"boolean"}}},"sheets_v4_GradientRule":{"description":"A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.","type":"object","properties":{"maxpoint":{"$ref":"#/components/schemas/sheets_v4_InterpolationPoint"},"midpoint":{"$ref":"#/components/schemas/sheets_v4_InterpolationPoint"},"minpoint":{"$ref":"#/components/schemas/sheets_v4_InterpolationPoint"}}},"sheets_v4_GridCoordinate":{"description":"A coordinate in a sheet. All indexes are zero-based.","type":"object","properties":{"columnIndex":{"description":"The column index of the coordinate.","format":"int32","type":"integer"},"rowIndex":{"description":"The row index of the coordinate.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet this coordinate is on.","format":"int32","type":"integer"}}},"sheets_v4_GridData":{"description":"Data in the grid, as well as metadata about the dimensions.","type":"object","properties":{"columnMetadata":{"description":"Metadata about the requested columns in the grid, starting with the column in start_column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionProperties"}},"rowData":{"description":"The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RowData"}},"rowMetadata":{"description":"Metadata about the requested rows in the grid, starting with the row in start_row.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionProperties"}},"startColumn":{"description":"The first column this GridData refers to, zero-based.","format":"int32","type":"integer"},"startRow":{"description":"The first row this GridData refers to, zero-based.","format":"int32","type":"integer"}}},"sheets_v4_GridProperties":{"description":"Properties of a grid.","type":"object","properties":{"columnCount":{"description":"The number of columns in the grid.","format":"int32","type":"integer"},"columnGroupControlAfter":{"description":"True if the column grouping control toggle is shown after the group.","type":"boolean"},"frozenColumnCount":{"description":"The number of columns that are frozen in the grid.","format":"int32","type":"integer"},"frozenRowCount":{"description":"The number of rows that are frozen in the grid.","format":"int32","type":"integer"},"hideGridlines":{"description":"True if the grid isn't showing gridlines in the UI.","type":"boolean"},"rowCount":{"description":"The number of rows in the grid.","format":"int32","type":"integer"},"rowGroupControlAfter":{"description":"True if the row grouping control toggle is shown after the group.","type":"boolean"}}},"sheets_v4_GridRange":{"description":"A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `\"Sheet1\"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.","type":"object","properties":{"endColumnIndex":{"description":"The end column (exclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"},"endRowIndex":{"description":"The end row (exclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet this range is on.","format":"int32","type":"integer"},"startColumnIndex":{"description":"The start column (inclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"},"startRowIndex":{"description":"The start row (inclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"}}},"sheets_v4_HistogramChartSpec":{"description":"A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.","type":"object","properties":{"bucketSize":{"description":"By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.","format":"double","type":"number"},"legendPosition":{"description":"The position of the chart legend.","enum":["HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND","INSIDE_LEGEND"],"type":"string"},"outlierPercentile":{"description":"The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5.","format":"double","type":"number"},"series":{"description":"The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_HistogramSeries"}},"showItemDividers":{"description":"Whether horizontal divider lines should be displayed between items in each column.","type":"boolean"}}},"sheets_v4_HistogramRule":{"description":"Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+","type":"object","properties":{"end":{"description":"The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.","format":"double","type":"number"},"interval":{"description":"The size of the buckets that are created. Must be positive.","format":"double","type":"number"},"start":{"description":"The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.","format":"double","type":"number"}}},"sheets_v4_HistogramSeries":{"description":"A histogram series containing the series color and data.","type":"object","properties":{"barColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"barColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_InsertCommentRequest":{"description":"Inserts a CommentThread into the spreadsheet. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmailAddress":{"description":"Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units.","type":"string"},"content":{"description":"The text of the comment, as plain text. This text content will be handled similarly to comments created in the Sheets editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"coordinate":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"}}},"sheets_v4_InsertCommentResponse":{"description":"The result of creating a comment. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentThread":{"$ref":"#/components/schemas/sheets_v4_CommentThread"}}},"sheets_v4_InsertDimensionRequest":{"description":"Inserts rows or columns in a sheet at a particular index.","type":"object","properties":{"inheritFromBefore":{"description":"Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green).","type":"boolean"},"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_InsertRangeRequest":{"description":"Inserts cells into a range, shifting the existing cells over or down.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"shiftDimension":{"description":"The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"}}},"sheets_v4_InterpolationPoint":{"description":"A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"type":{"description":"How the value should be interpreted.","enum":["INTERPOLATION_POINT_TYPE_UNSPECIFIED","MIN","MAX","NUMBER","PERCENT","PERCENTILE"],"type":"string"},"value":{"description":"The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.","type":"string"}}},"sheets_v4_Interval":{"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.","type":"object","properties":{"endTime":{"description":"Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.","format":"google-datetime","type":"string"},"startTime":{"description":"Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.","format":"google-datetime","type":"string"}}},"sheets_v4_IterativeCalculationSettings":{"description":"Settings to control how circular dependencies are resolved with iterative calculation.","type":"object","properties":{"convergenceThreshold":{"description":"When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.","format":"double","type":"number"},"maxIterations":{"description":"When iterative calculation is enabled, the maximum number of calculation rounds to perform.","format":"int32","type":"integer"}}},"sheets_v4_KeyValueFormat":{"description":"Formatting options for key value.","type":"object","properties":{"position":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"}}},"sheets_v4_LineStyle":{"description":"Properties that describe the style of a line.","type":"object","properties":{"type":{"description":"The dash type of the line.","enum":["LINE_DASH_TYPE_UNSPECIFIED","INVISIBLE","CUSTOM","SOLID","DOTTED","MEDIUM_DASHED","MEDIUM_DASHED_DOTTED","LONG_DASHED","LONG_DASHED_DOTTED"],"type":"string"},"width":{"description":"The thickness of the line, in px.","format":"int32","type":"integer"}}},"sheets_v4_Link":{"description":"An external or local reference.","type":"object","properties":{"uri":{"description":"The link identifier.","type":"string"}}},"sheets_v4_LookerDataSourceSpec":{"description":"The specification of a Looker data source.","type":"object","properties":{"explore":{"description":"Name of a Looker model explore.","type":"string"},"instanceUri":{"description":"A Looker instance URL.","type":"string"},"model":{"description":"Name of a Looker model.","type":"string"}}},"sheets_v4_ManualRule":{"description":"Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+","type":"object","properties":{"groups":{"description":"The list of group names and the corresponding items from the source data that map to each group name.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ManualRuleGroup"}}}},"sheets_v4_ManualRuleGroup":{"description":"A group name and a list of items from the source data that should be placed in the group with this name.","type":"object","properties":{"groupName":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"},"items":{"description":"The items in the source data that should be placed into this group. Each item may be a string, number, or boolean. Items may appear in at most one group within a given ManualRule. Items that do not appear in any group will appear on their own.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}}}},"sheets_v4_MatchedDeveloperMetadata":{"description":"A developer metadata entry and the data filters specified in the original request that matched it.","type":"object","properties":{"dataFilters":{"description":"All filters matching the returned developer metadata.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}},"sheets_v4_MatchedValueRange":{"description":"A value range that was matched by one or more data filers.","type":"object","properties":{"dataFilters":{"description":"The DataFilters from the request that matched the range of values.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"valueRange":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}},"sheets_v4_MergeCellsRequest":{"description":"Merges all cells in the range.","type":"object","properties":{"mergeType":{"description":"How the cells should be merged.","enum":["MERGE_ALL","MERGE_COLUMNS","MERGE_ROWS"],"type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_MoveDimensionRequest":{"description":"Moves one or more rows or columns.","type":"object","properties":{"destinationIndex":{"description":"The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move `\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be `ROWS [1..3)`,and the destination index would be `\"4\"` (the zero-based index of row 5). The end result would be `A1..A5` of `0, 3, 1, 2, 4`.","format":"int32","type":"integer"},"source":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_NamedRange":{"description":"A named range.","type":"object","properties":{"name":{"description":"The name of the named range.","type":"string"},"namedRangeId":{"description":"The ID of the named range.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_NumberFormat":{"description":"The number format of a cell.","type":"object","properties":{"pattern":{"description":"Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for more information about the supported patterns.","type":"string"},"type":{"description":"The type of the number format. When writing, this field must be set.","enum":["NUMBER_FORMAT_TYPE_UNSPECIFIED","TEXT","NUMBER","PERCENT","CURRENCY","DATE","TIME","DATE_TIME","SCIENTIFIC"],"type":"string"}}},"sheets_v4_OrgChartSpec":{"description":"An org chart. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain \"Alice\", \"Bob\", \"Cathy\", parent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain \"CEO\", \"President\", \"VP Sales\".","type":"object","properties":{"labels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"nodeColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"nodeColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"nodeSize":{"description":"The size of the org chart nodes.","enum":["ORG_CHART_LABEL_SIZE_UNSPECIFIED","SMALL","MEDIUM","LARGE"],"type":"string"},"parentLabels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"selectedNodeColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"selectedNodeColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"tooltips":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_OverlayPosition":{"description":"The location an object is overlaid on top of a grid.","type":"object","properties":{"anchorCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"heightPixels":{"description":"The height of the object, in pixels. Defaults to 371.","format":"int32","type":"integer"},"offsetXPixels":{"description":"The horizontal offset, in pixels, that the object is offset from the anchor cell.","format":"int32","type":"integer"},"offsetYPixels":{"description":"The vertical offset, in pixels, that the object is offset from the anchor cell.","format":"int32","type":"integer"},"widthPixels":{"description":"The width of the object, in pixels. Defaults to 600.","format":"int32","type":"integer"}}},"sheets_v4_Padding":{"description":"The amount of padding around the cell, in pixels. When updating padding, every field must be specified.","type":"object","properties":{"bottom":{"description":"The bottom padding of the cell.","format":"int32","type":"integer"},"left":{"description":"The left padding of the cell.","format":"int32","type":"integer"},"right":{"description":"The right padding of the cell.","format":"int32","type":"integer"},"top":{"description":"The top padding of the cell.","format":"int32","type":"integer"}}},"sheets_v4_PasteDataRequest":{"description":"Inserts data into the spreadsheet starting at the specified coordinate.","type":"object","properties":{"coordinate":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"data":{"description":"The data to insert.","type":"string"},"delimiter":{"description":"The delimiter in the data.","type":"string"},"html":{"description":"True if the data is HTML.","type":"boolean"},"type":{"description":"How the data should be pasted.","enum":["PASTE_NORMAL","PASTE_VALUES","PASTE_FORMAT","PASTE_NO_BORDERS","PASTE_FORMULA","PASTE_DATA_VALIDATION","PASTE_CONDITIONAL_FORMATTING"],"type":"string"}}},"sheets_v4_PersonProperties":{"description":"Properties specific to a linked person.","type":"object","properties":{"displayFormat":{"description":"Optional. The display format of the person chip. If not set, the default display format is used.","enum":["DISPLAY_FORMAT_UNSPECIFIED","DEFAULT","LAST_NAME_COMMA_FIRST_NAME","EMAIL"],"type":"string"},"email":{"description":"Required. The email address linked to this person. This field is always present.","type":"string"}}},"sheets_v4_PieChartSpec":{"description":"A pie chart.","type":"object","properties":{"domain":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"legendPosition":{"description":"Where the legend of the pie chart should be drawn.","enum":["PIE_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND","LABELED_LEGEND"],"type":"string"},"pieHole":{"description":"The size of the hole in the pie chart.","format":"double","type":"number"},"series":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"threeDimensional":{"description":"True if the pie is three dimensional.","type":"boolean"}}},"sheets_v4_PivotFilterCriteria":{"description":"Criteria for showing/hiding rows in a pivot table.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"visibleByDefault":{"description":"Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.","type":"boolean"},"visibleValues":{"description":"Values that should be included. Values not listed here are excluded.","type":"array","items":{"type":"string"}}}},"sheets_v4_PivotFilterSpec":{"description":"The pivot table filter criteria associated with a specific source column offset.","type":"object","properties":{"columnOffsetIndex":{"description":"The zero-based column offset of the source range.","format":"int32","type":"integer"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"filterCriteria":{"$ref":"#/components/schemas/sheets_v4_PivotFilterCriteria"}}},"sheets_v4_PivotGroup":{"description":"A single grouping (either row or column) in a pivot table.","type":"object","properties":{"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"groupLimit":{"$ref":"#/components/schemas/sheets_v4_PivotGroupLimit"},"groupRule":{"$ref":"#/components/schemas/sheets_v4_PivotGroupRule"},"label":{"description":"The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables created before December 2017 do not have header labels. If you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then create a new pivot table with same parameters. +--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+","type":"string"},"repeatHeadings":{"description":"True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repetition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to \"Q1 Mar\", \"Q1\" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause \"Q1\" to be repeated for \"Feb\" and \"Mar\". +--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+","type":"boolean"},"showTotals":{"description":"True if the pivot table should include the totals for this grouping.","type":"boolean"},"sortOrder":{"description":"The order the values in this group should be sorted.","enum":["SORT_ORDER_UNSPECIFIED","ASCENDING","DESCENDING"],"type":"string"},"sourceColumnOffset":{"description":"The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.","format":"int32","type":"integer"},"valueBucket":{"$ref":"#/components/schemas/sheets_v4_PivotGroupSortValueBucket"},"valueMetadata":{"description":"Metadata about values in the grouping.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotGroupValueMetadata"}}}},"sheets_v4_PivotGroupLimit":{"description":"The count limit on rows or columns in the pivot group.","type":"object","properties":{"applyOrder":{"description":"The order in which the group limit is applied to the pivot table. Pivot group limits are applied from lower to higher order number. Order numbers are normalized to consecutive integers from 0. For write request, to fully customize the applying orders, all pivot group limits should have this field set with an unique number. Otherwise, the order is determined by the index in the PivotTable.rows list and then the PivotTable.columns list.","format":"int32","type":"integer"},"countLimit":{"description":"The count limit.","format":"int32","type":"integer"}}},"sheets_v4_PivotGroupRule":{"description":"An optional setting on a PivotGroup that defines buckets for the values in the source data column rather than breaking out each individual value. Only one PivotGroup with a group rule may be added for each column in the source data, though on any given column you may add both a PivotGroup that has a rule and a PivotGroup that does not.","type":"object","properties":{"dateTimeRule":{"$ref":"#/components/schemas/sheets_v4_DateTimeRule"},"histogramRule":{"$ref":"#/components/schemas/sheets_v4_HistogramRule"},"manualRule":{"$ref":"#/components/schemas/sheets_v4_ManualRule"}}},"sheets_v4_PivotGroupSortValueBucket":{"description":"Information about which values in a pivot group should be used for sorting.","type":"object","properties":{"buckets":{"description":"Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the \"Grand Total\" over the column groups. If a single value is listed, this would correspond to using the \"Total\" of that bucket.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}},"valuesIndex":{"description":"The offset in the PivotTable.values list which the values in this grouping should be sorted by.","format":"int32","type":"integer"}}},"sheets_v4_PivotGroupValueMetadata":{"description":"Metadata about a value in a pivot grouping.","type":"object","properties":{"collapsed":{"description":"True if the data corresponding to the value is collapsed.","type":"boolean"},"value":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}}},"sheets_v4_PivotTable":{"description":"A pivot table.","type":"object","properties":{"columns":{"description":"Each column grouping in the pivot table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotGroup"}},"criteria":{"description":"An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. This field is deprecated in favor of filter_specs.","type":"object","additionalProperties":{"$ref":"#/components/schemas/sheets_v4_PivotFilterCriteria"}},"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"The ID of the data source the pivot table is reading data from.","type":"string"},"filterSpecs":{"description":"The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotFilterSpec"}},"rows":{"description":"Each row grouping in the pivot table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotGroup"}},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"valueLayout":{"description":"Whether values should be listed horizontally (as columns) or vertically (as rows).","enum":["HORIZONTAL","VERTICAL"],"type":"string"},"values":{"description":"A list of values to include in the pivot table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotValue"}}}},"sheets_v4_PivotValue":{"description":"The definition of how a value in a pivot table should be calculated.","type":"object","properties":{"calculatedDisplayType":{"description":"If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as \"Show As\" in the value section of a pivot table.","enum":["PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED","PERCENT_OF_ROW_TOTAL","PERCENT_OF_COLUMN_TOTAL","PERCENT_OF_GRAND_TOTAL"],"type":"string"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"formula":{"description":"A custom formula to calculate the value. The formula must start with an `=` character.","type":"string"},"name":{"description":"A name to use for the value.","type":"string"},"sourceColumnOffset":{"description":"The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.","format":"int32","type":"integer"},"summarizeFunction":{"description":"A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.","enum":["PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED","SUM","COUNTA","COUNT","COUNTUNIQUE","AVERAGE","MAX","MIN","MEDIAN","PRODUCT","STDEV","STDEVP","VAR","VARP","CUSTOM","NONE"],"type":"string"}}},"sheets_v4_PointStyle":{"description":"The style of a point on the chart.","type":"object","properties":{"shape":{"description":"The point shape. If empty or unspecified, a default shape is used.","enum":["POINT_SHAPE_UNSPECIFIED","CIRCLE","DIAMOND","HEXAGON","PENTAGON","SQUARE","STAR","TRIANGLE","X_MARK"],"type":"string"},"size":{"description":"The point size. If empty, a default size is used.","format":"double","type":"number"}}},"sheets_v4_Post":{"description":"Represents a single post in a comment thread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmail":{"description":"Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assignee_email` exceeds 2048 UTF-8 code units.","type":"string"},"author":{"$ref":"#/components/schemas/sheets_v4_PostAuthor"},"commentAction":{"description":"Action taken as part of creating the post.","enum":["COMMENT_ACTION_TYPE_UNSPECIFIED","NO_COMMENT_ACTION_CHANGE","RESOLVE","REOPEN"],"type":"string"},"content":{"description":"The content of the post. Required to be non-empty if comment_action is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Sheets editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.","type":"string"},"contentHtml":{"description":"Output only. The content of the post as HTML.","type":"string"},"createTime":{"description":"Output only. The time the post was created.","format":"google-datetime","type":"string"},"deleted":{"description":"Output only. Whether the post is deleted. If `true`, content and author fields will be empty.","type":"boolean"},"fromCopiedSpreadsheet":{"description":"Output only. Whether the post is from a copied spreadsheet. This field cannot be set directly by callers.","type":"boolean"},"fromImportedSpreadsheet":{"description":"Output only. Whether the post is from an imported spreadsheet. This field cannot be set directly by callers.","type":"boolean"},"postId":{"description":"Output only. The unique ID of the post.","type":"string"},"updateTime":{"description":"Output only. The time the post was last updated.","format":"google-datetime","type":"string"}}},"sheets_v4_PostAuthor":{"description":"Represents a user who authored a comment post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anonymous":{"description":"Whether the user is anonymous.","type":"boolean"},"displayName":{"description":"The display name of the user. May be absent if the author is anonymous.","type":"string"},"me":{"description":"Whether the user is the authenticated user making the request.","type":"boolean"},"user":{"description":"The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported spreadsheet.","type":"string"}}},"sheets_v4_ProtectedRange":{"description":"A protected range.","type":"object","properties":{"description":{"description":"The description of this protected range.","type":"string"},"editors":{"$ref":"#/components/schemas/sheets_v4_Editors"},"namedRangeId":{"description":"The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.","type":"string"},"protectedRangeId":{"description":"The ID of the protected range. This field is read-only.","format":"int32","type":"integer"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"requestingUserCanEdit":{"description":"True if the user who requested this protected range can edit the protected area. This field is read-only.","type":"boolean"},"tableId":{"description":"The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.","type":"string"},"unprotectedRanges":{"description":"The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}},"warningOnly":{"description":"True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors are ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document.","type":"boolean"}}},"sheets_v4_RandomizeRangeRequest":{"description":"Randomizes the order of the rows in a range.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_RefreshCancellationStatus":{"description":"The status of a refresh cancellation. You can send a cancel request to explicitly cancel one or multiple data source object refreshes.","type":"object","properties":{"errorCode":{"description":"The error code.","enum":["REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED","EXECUTION_NOT_FOUND","CANCEL_PERMISSION_DENIED","QUERY_EXECUTION_COMPLETED","CONCURRENT_CANCELLATION","CANCEL_OTHER_ERROR"],"type":"string"},"state":{"description":"The state of a call to cancel a refresh in Sheets.","enum":["REFRESH_CANCELLATION_STATE_UNSPECIFIED","CANCEL_SUCCEEDED","CANCEL_FAILED"],"type":"string"}}},"sheets_v4_RefreshDataSourceObjectExecutionStatus":{"description":"The execution status of refreshing one data source object.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"reference":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReference"}}},"sheets_v4_RefreshDataSourceRequest":{"description":"Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.","type":"object","properties":{"dataSourceId":{"description":"Reference to a DataSource. If specified, refreshes all associated data source objects for the data source.","type":"string"},"force":{"description":"Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately.","type":"boolean"},"isAll":{"description":"Refreshes all existing data source objects in the spreadsheet.","type":"boolean"},"references":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReferences"}}},"sheets_v4_RefreshDataSourceResponse":{"description":"The response from refreshing one or multiple data source objects.","type":"object","properties":{"statuses":{"description":"All the refresh status for the data source object references specified in the request. If is_all is specified, the field contains only those in failure status.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RefreshDataSourceObjectExecutionStatus"}}}},"sheets_v4_RepeatCellRequest":{"description":"Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the formula's ranges static, use the `$` indicator. For example, use the formula `=$A$1` to prevent both the row and the column from incrementing.","type":"object","properties":{"cell":{"$ref":"#/components/schemas/sheets_v4_CellData"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `cell` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_Request":{"description":"A single kind of update to apply to a spreadsheet.","type":"object","properties":{"addBanding":{"$ref":"#/components/schemas/sheets_v4_AddBandingRequest"},"addChart":{"$ref":"#/components/schemas/sheets_v4_AddChartRequest"},"addCommentReply":{"$ref":"#/components/schemas/sheets_v4_AddCommentReplyRequest"},"addConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_AddConditionalFormatRuleRequest"},"addDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_AddDimensionGroupRequest"},"addFilterView":{"$ref":"#/components/schemas/sheets_v4_AddFilterViewRequest"},"addNamedRange":{"$ref":"#/components/schemas/sheets_v4_AddNamedRangeRequest"},"addProtectedRange":{"$ref":"#/components/schemas/sheets_v4_AddProtectedRangeRequest"},"addSheet":{"$ref":"#/components/schemas/sheets_v4_AddSheetRequest"},"addSlicer":{"$ref":"#/components/schemas/sheets_v4_AddSlicerRequest"},"addTable":{"$ref":"#/components/schemas/sheets_v4_AddTableRequest"},"appendCells":{"$ref":"#/components/schemas/sheets_v4_AppendCellsRequest"},"appendDimension":{"$ref":"#/components/schemas/sheets_v4_AppendDimensionRequest"},"autoFill":{"$ref":"#/components/schemas/sheets_v4_AutoFillRequest"},"autoResizeDimensions":{"$ref":"#/components/schemas/sheets_v4_AutoResizeDimensionsRequest"},"clearBasicFilter":{"$ref":"#/components/schemas/sheets_v4_ClearBasicFilterRequest"},"copyPaste":{"$ref":"#/components/schemas/sheets_v4_CopyPasteRequest"},"createDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_CreateDeveloperMetadataRequest"},"cutPaste":{"$ref":"#/components/schemas/sheets_v4_CutPasteRequest"},"deleteBanding":{"$ref":"#/components/schemas/sheets_v4_DeleteBandingRequest"},"deleteComment":{"$ref":"#/components/schemas/sheets_v4_DeleteCommentRequest"},"deleteCommentReply":{"$ref":"#/components/schemas/sheets_v4_DeleteCommentReplyRequest"},"deleteConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_DeleteConditionalFormatRuleRequest"},"deleteDataSource":{"$ref":"#/components/schemas/sheets_v4_DeleteDataSourceRequest"},"deleteDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_DeleteDeveloperMetadataRequest"},"deleteDimension":{"$ref":"#/components/schemas/sheets_v4_DeleteDimensionRequest"},"deleteDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_DeleteDimensionGroupRequest"},"deleteDuplicates":{"$ref":"#/components/schemas/sheets_v4_DeleteDuplicatesRequest"},"deleteEmbeddedObject":{"$ref":"#/components/schemas/sheets_v4_DeleteEmbeddedObjectRequest"},"deleteFilterView":{"$ref":"#/components/schemas/sheets_v4_DeleteFilterViewRequest"},"deleteNamedRange":{"$ref":"#/components/schemas/sheets_v4_DeleteNamedRangeRequest"},"deleteProtectedRange":{"$ref":"#/components/schemas/sheets_v4_DeleteProtectedRangeRequest"},"deleteRange":{"$ref":"#/components/schemas/sheets_v4_DeleteRangeRequest"},"deleteSheet":{"$ref":"#/components/schemas/sheets_v4_DeleteSheetRequest"},"deleteTable":{"$ref":"#/components/schemas/sheets_v4_DeleteTableRequest"},"duplicateFilterView":{"$ref":"#/components/schemas/sheets_v4_DuplicateFilterViewRequest"},"duplicateSheet":{"$ref":"#/components/schemas/sheets_v4_DuplicateSheetRequest"},"findReplace":{"$ref":"#/components/schemas/sheets_v4_FindReplaceRequest"},"insertComment":{"$ref":"#/components/schemas/sheets_v4_InsertCommentRequest"},"insertDimension":{"$ref":"#/components/schemas/sheets_v4_InsertDimensionRequest"},"insertRange":{"$ref":"#/components/schemas/sheets_v4_InsertRangeRequest"},"mergeCells":{"$ref":"#/components/schemas/sheets_v4_MergeCellsRequest"},"moveDimension":{"$ref":"#/components/schemas/sheets_v4_MoveDimensionRequest"},"pasteData":{"$ref":"#/components/schemas/sheets_v4_PasteDataRequest"},"randomizeRange":{"$ref":"#/components/schemas/sheets_v4_RandomizeRangeRequest"},"repeatCell":{"$ref":"#/components/schemas/sheets_v4_RepeatCellRequest"},"setBasicFilter":{"$ref":"#/components/schemas/sheets_v4_SetBasicFilterRequest"},"setDataValidation":{"$ref":"#/components/schemas/sheets_v4_SetDataValidationRequest"},"sortRange":{"$ref":"#/components/schemas/sheets_v4_SortRangeRequest"},"textToColumns":{"$ref":"#/components/schemas/sheets_v4_TextToColumnsRequest"},"trimWhitespace":{"$ref":"#/components/schemas/sheets_v4_TrimWhitespaceRequest"},"unmergeCells":{"$ref":"#/components/schemas/sheets_v4_UnmergeCellsRequest"},"updateBanding":{"$ref":"#/components/schemas/sheets_v4_UpdateBandingRequest"},"updateBorders":{"$ref":"#/components/schemas/sheets_v4_UpdateBordersRequest"},"updateCells":{"$ref":"#/components/schemas/sheets_v4_UpdateCellsRequest"},"updateChartSpec":{"$ref":"#/components/schemas/sheets_v4_UpdateChartSpecRequest"},"updateCommentPost":{"$ref":"#/components/schemas/sheets_v4_UpdateCommentPostRequest"},"updateConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_UpdateConditionalFormatRuleRequest"},"updateDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_UpdateDeveloperMetadataRequest"},"updateDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_UpdateDimensionGroupRequest"},"updateDimensionProperties":{"$ref":"#/components/schemas/sheets_v4_UpdateDimensionPropertiesRequest"},"updateEmbeddedObjectBorder":{"$ref":"#/components/schemas/sheets_v4_UpdateEmbeddedObjectBorderRequest"},"updateEmbeddedObjectPosition":{"$ref":"#/components/schemas/sheets_v4_UpdateEmbeddedObjectPositionRequest"},"updateFilterView":{"$ref":"#/components/schemas/sheets_v4_UpdateFilterViewRequest"},"updateNamedRange":{"$ref":"#/components/schemas/sheets_v4_UpdateNamedRangeRequest"},"updateProtectedRange":{"$ref":"#/components/schemas/sheets_v4_UpdateProtectedRangeRequest"},"updateSheetProperties":{"$ref":"#/components/schemas/sheets_v4_UpdateSheetPropertiesRequest"},"updateSlicerSpec":{"$ref":"#/components/schemas/sheets_v4_UpdateSlicerSpecRequest"},"updateSpreadsheetProperties":{"$ref":"#/components/schemas/sheets_v4_UpdateSpreadsheetPropertiesRequest"},"updateTable":{"$ref":"#/components/schemas/sheets_v4_UpdateTableRequest"}}},"sheets_v4_Response":{"description":"A single response from an update.","type":"object","properties":{"addBanding":{"$ref":"#/components/schemas/sheets_v4_AddBandingResponse"},"addChart":{"$ref":"#/components/schemas/sheets_v4_AddChartResponse"},"addCommentReply":{"$ref":"#/components/schemas/sheets_v4_AddCommentReplyResponse"},"addDataSource":{"$ref":"#/components/schemas/sheets_v4_AddDataSourceResponse"},"addDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_AddDimensionGroupResponse"},"addFilterView":{"$ref":"#/components/schemas/sheets_v4_AddFilterViewResponse"},"addNamedRange":{"$ref":"#/components/schemas/sheets_v4_AddNamedRangeResponse"},"addProtectedRange":{"$ref":"#/components/schemas/sheets_v4_AddProtectedRangeResponse"},"addSheet":{"$ref":"#/components/schemas/sheets_v4_AddSheetResponse"},"addSlicer":{"$ref":"#/components/schemas/sheets_v4_AddSlicerResponse"},"addTable":{"$ref":"#/components/schemas/sheets_v4_AddTableResponse"},"cancelDataSourceRefresh":{"$ref":"#/components/schemas/sheets_v4_CancelDataSourceRefreshResponse"},"createDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_CreateDeveloperMetadataResponse"},"deleteConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_DeleteConditionalFormatRuleResponse"},"deleteDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_DeleteDeveloperMetadataResponse"},"deleteDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_DeleteDimensionGroupResponse"},"deleteDuplicates":{"$ref":"#/components/schemas/sheets_v4_DeleteDuplicatesResponse"},"duplicateFilterView":{"$ref":"#/components/schemas/sheets_v4_DuplicateFilterViewResponse"},"duplicateSheet":{"$ref":"#/components/schemas/sheets_v4_DuplicateSheetResponse"},"findReplace":{"$ref":"#/components/schemas/sheets_v4_FindReplaceResponse"},"insertComment":{"$ref":"#/components/schemas/sheets_v4_InsertCommentResponse"},"refreshDataSource":{"$ref":"#/components/schemas/sheets_v4_RefreshDataSourceResponse"},"trimWhitespace":{"$ref":"#/components/schemas/sheets_v4_TrimWhitespaceResponse"},"updateConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_UpdateConditionalFormatRuleResponse"},"updateDataSource":{"$ref":"#/components/schemas/sheets_v4_UpdateDataSourceResponse"},"updateDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_UpdateDeveloperMetadataResponse"},"updateEmbeddedObjectPosition":{"$ref":"#/components/schemas/sheets_v4_UpdateEmbeddedObjectPositionResponse"}}},"sheets_v4_RichLinkProperties":{"description":"Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes.","type":"object","properties":{"mimeType":{"description":"Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive).","readOnly":true,"type":"string"},"uri":{"description":"Required. The URI to the link. This is always present.","type":"string"}}},"sheets_v4_RowData":{"description":"Data about each cell in a row.","type":"object","properties":{"values":{"description":"The values in the row, one per column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CellData"}}}},"sheets_v4_ScorecardChartSpec":{"description":"A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time.","type":"object","properties":{"aggregateType":{"description":"The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the key_value_data or baseline_value_data instead for data source charts. This field is optional.","enum":["CHART_AGGREGATE_TYPE_UNSPECIFIED","AVERAGE","COUNT","MAX","MEDIAN","MIN","SUM"],"type":"string"},"baselineValueData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"baselineValueFormat":{"$ref":"#/components/schemas/sheets_v4_BaselineValueFormat"},"customFormatOptions":{"$ref":"#/components/schemas/sheets_v4_ChartCustomNumberFormatOptions"},"keyValueData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"keyValueFormat":{"$ref":"#/components/schemas/sheets_v4_KeyValueFormat"},"numberFormatSource":{"description":"The number format source used in the scorecard chart. This field is optional.","enum":["CHART_NUMBER_FORMAT_SOURCE_UNDEFINED","FROM_DATA","CUSTOM"],"type":"string"},"scaleFactor":{"description":"Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.","format":"double","type":"number"}}},"sheets_v4_SearchDeveloperMetadataRequest":{"description":"A request to retrieve all developer metadata matching the set of specified criteria.","type":"object","properties":{"dataFilters":{"description":"The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}}}},"sheets_v4_SearchDeveloperMetadataResponse":{"description":"A reply to a developer metadata search request.","type":"object","properties":{"matchedDeveloperMetadata":{"description":"The metadata matching the criteria of the search request.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_MatchedDeveloperMetadata"}}}},"sheets_v4_SetBasicFilterRequest":{"description":"Sets the basic filter associated with a sheet.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_BasicFilter"}}},"sheets_v4_SetDataValidationRequest":{"description":"Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.","type":"object","properties":{"filteredRowsIncluded":{"description":"Optional. If true, the data validation rule will be applied to the filtered rows as well.","type":"boolean"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rule":{"$ref":"#/components/schemas/sheets_v4_DataValidationRule"}}},"sheets_v4_Sheet":{"description":"A sheet in a spreadsheet.","type":"object","properties":{"bandedRanges":{"description":"The banded (alternating colors) ranges on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BandedRange"}},"basicFilter":{"$ref":"#/components/schemas/sheets_v4_BasicFilter"},"charts":{"description":"The specifications of every chart on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_EmbeddedChart"}},"columnGroups":{"description":"All column groups on this sheet, ordered by increasing range start index, then by group depth.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}},"commentAnchors":{"description":"The comment anchors on this sheet. [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CommentAnchor"}},"conditionalFormats":{"description":"The conditional format rules in this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}},"data":{"description":"Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D). For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridData"}},"developerMetadata":{"description":"The developer metadata associated with a sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}},"filterViews":{"description":"The filter views in this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterView"}},"merges":{"description":"The ranges that are merged together.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}},"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"},"protectedRanges":{"description":"The protected ranges in this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}},"rowGroups":{"description":"All row groups on this sheet, ordered by increasing range start index, then by group depth.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}},"slicers":{"description":"The slicers on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Slicer"}},"tables":{"description":"The tables on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Table"}}}},"sheets_v4_SheetProperties":{"description":"Properties of a sheet.","type":"object","properties":{"dataSourceSheetProperties":{"$ref":"#/components/schemas/sheets_v4_DataSourceSheetProperties"},"gridProperties":{"$ref":"#/components/schemas/sheets_v4_GridProperties"},"hidden":{"description":"True if the sheet is hidden in the UI, false if it's visible.","type":"boolean"},"index":{"description":"The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in \"before the move\" indexes. For example, if there were three sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.","format":"int32","type":"integer"},"rightToLeft":{"description":"True if the sheet is an RTL sheet instead of an LTR sheet.","type":"boolean"},"sheetId":{"description":"The ID of the sheet. Must be non-negative. This field cannot be changed once set.","format":"int32","type":"integer"},"sheetType":{"description":"The type of sheet. Defaults to GRID. This field cannot be changed once set.","enum":["SHEET_TYPE_UNSPECIFIED","GRID","OBJECT","DATA_SOURCE"],"type":"string"},"tabColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"tabColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"title":{"description":"The name of the sheet.","type":"string"}}},"sheets_v4_Slicer":{"description":"A slicer in a sheet.","type":"object","properties":{"position":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"},"slicerId":{"description":"The ID of the slicer.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_SlicerSpec"}}},"sheets_v4_SlicerSpec":{"description":"The specifications of a slicer.","type":"object","properties":{"applyToPivotTables":{"description":"True if the filter should apply to pivot tables. If not set, default to `True`.","type":"boolean"},"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"columnIndex":{"description":"The zero-based column index in the data table on which the filter is applied to.","format":"int32","type":"integer"},"dataRange":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"filterCriteria":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"},"horizontalAlignment":{"description":"The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`","enum":["HORIZONTAL_ALIGN_UNSPECIFIED","LEFT","CENTER","RIGHT"],"type":"string"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"title":{"description":"The title of the slicer.","type":"string"}}},"sheets_v4_SortRangeRequest":{"description":"Sorts data in rows based on a sort order per column.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sortSpecs":{"description":"The sort order per column. Later specifications are used when values are equal in the earlier specifications.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}}}},"sheets_v4_SortSpec":{"description":"A sort order associated with a specific column or row.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"dimensionIndex":{"description":"The dimension the sort should be applied to.","format":"int32","type":"integer"},"foregroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"foregroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"sortOrder":{"description":"The order data should be sorted.","enum":["SORT_ORDER_UNSPECIFIED","ASCENDING","DESCENDING"],"type":"string"}}},"sheets_v4_SourceAndDestination":{"description":"A combination of a source range and how to extend that source.","type":"object","properties":{"dimension":{"description":"The dimension that data should be filled into.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"fillLength":{"description":"The number of rows or columns that data should be filled into. Positive numbers expand beyond the last row or last column of the source. Negative numbers expand before the first row or first column of the source.","format":"int32","type":"integer"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_Spreadsheet":{"description":"Resource that represents a spreadsheet.","type":"object","properties":{"comments":{"description":"The comment threads associated with the spreadsheet. [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the spreadsheet. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"dataSourceSchedules":{"description":"Output only. A list of data source refresh schedules.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshSchedule"}},"dataSources":{"description":"A list of external data sources connected with the spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSource"}},"developerMetadata":{"description":"The developer metadata associated with a spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}},"namedRanges":{"description":"The named ranges defined in a spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}},"properties":{"$ref":"#/components/schemas/sheets_v4_SpreadsheetProperties"},"sheets":{"description":"The sheets that are part of a spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Sheet"}},"spreadsheetId":{"description":"The ID of the spreadsheet. This field is read-only.","type":"string"},"spreadsheetUrl":{"description":"The url of the spreadsheet. This field is read-only.","type":"string"}}},"sheets_v4_SpreadsheetProperties":{"description":"Properties of a spreadsheet.","type":"object","properties":{"autoRecalc":{"description":"The amount of time to wait before volatile functions are recalculated.","enum":["RECALCULATION_INTERVAL_UNSPECIFIED","ON_CHANGE","MINUTE","HOUR"],"type":"string"},"defaultFormat":{"$ref":"#/components/schemas/sheets_v4_CellFormat"},"importFunctionsExternalUrlAccessAllowed":{"description":"Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the [allowlisting feature](https://support.google.com/a?p=url_allowlist).","type":"boolean"},"iterativeCalculationSettings":{"$ref":"#/components/schemas/sheets_v4_IterativeCalculationSettings"},"locale":{"description":"The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported.","type":"string"},"spreadsheetTheme":{"$ref":"#/components/schemas/sheets_v4_SpreadsheetTheme"},"timeZone":{"description":"The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`.","type":"string"},"title":{"description":"The title of the spreadsheet.","type":"string"}}},"sheets_v4_SpreadsheetTheme":{"description":"Represents spreadsheet theme","type":"object","properties":{"primaryFontFamily":{"description":"Name of the primary font family.","type":"string"},"themeColors":{"description":"The spreadsheet theme color pairs. To update you must provide all theme color pairs.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ThemeColorPair"}}}},"sheets_v4_Table":{"description":"A table.","type":"object","properties":{"columnProperties":{"description":"The table column properties.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_TableColumnProperties"}},"name":{"description":"The table name. This is unique to all tables in the same spreadsheet.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rowsProperties":{"$ref":"#/components/schemas/sheets_v4_TableRowsProperties"},"tableId":{"description":"The id of the table.","type":"string"}}},"sheets_v4_TableColumnDataValidationRule":{"description":"A data validation rule for a column in a table.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"}}},"sheets_v4_TableColumnProperties":{"description":"The table column.","type":"object","properties":{"columnIndex":{"description":"The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet.","format":"int32","type":"integer"},"columnName":{"description":"The column name.","type":"string"},"columnType":{"description":"The column type.","enum":["COLUMN_TYPE_UNSPECIFIED","DOUBLE","CURRENCY","PERCENT","DATE","TIME","DATE_TIME","TEXT","BOOLEAN","DROPDOWN","FILES_CHIP","PEOPLE_CHIP","FINANCE_CHIP","PLACE_CHIP","RATINGS_CHIP"],"type":"string"},"dataValidationRule":{"$ref":"#/components/schemas/sheets_v4_TableColumnDataValidationRule"}}},"sheets_v4_TableRowsProperties":{"description":"The table row properties.","type":"object","properties":{"firstBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"footerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"headerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"secondBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_TextFormat":{"description":"The format of a run of text in a cell. Absent values indicate that the field isn't specified.","type":"object","properties":{"bold":{"description":"True if the text is bold.","type":"boolean"},"fontFamily":{"description":"The font family.","type":"string"},"fontSize":{"description":"The size of the font.","format":"int32","type":"integer"},"foregroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"foregroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"italic":{"description":"True if the text is italicized.","type":"boolean"},"link":{"$ref":"#/components/schemas/sheets_v4_Link"},"strikethrough":{"description":"True if the text has a strikethrough.","type":"boolean"},"underline":{"description":"True if the text is underlined.","type":"boolean"}}},"sheets_v4_TextFormatRun":{"description":"A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set.","type":"object","properties":{"format":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"startIndex":{"description":"The zero-based character index where this run starts, in UTF-16 code units.","format":"int32","type":"integer"}}},"sheets_v4_TextPosition":{"description":"Position settings for text.","type":"object","properties":{"horizontalAlignment":{"description":"Horizontal alignment setting for the piece of text.","enum":["HORIZONTAL_ALIGN_UNSPECIFIED","LEFT","CENTER","RIGHT"],"type":"string"}}},"sheets_v4_TextRotation":{"description":"The rotation applied to text in a cell.","type":"object","properties":{"angle":{"description":"The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counterclockwise direction, whereas for RTL they are in the clockwise direction","format":"int32","type":"integer"},"vertical":{"description":"If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: | V | | e | | r | | t | | i | | c | | a | | l |","type":"boolean"}}},"sheets_v4_TextToColumnsRequest":{"description":"Splits a column of text into multiple columns, based on a delimiter in each cell.","type":"object","properties":{"delimiter":{"description":"The delimiter to use. Used only if delimiterType is CUSTOM.","type":"string"},"delimiterType":{"description":"The delimiter type to use.","enum":["DELIMITER_TYPE_UNSPECIFIED","COMMA","SEMICOLON","PERIOD","SPACE","CUSTOM","AUTODETECT"],"type":"string"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_ThemeColorPair":{"description":"A pair mapping a spreadsheet theme color type to the concrete color it represents.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"colorType":{"description":"The type of the spreadsheet theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","TEXT","BACKGROUND","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","LINK"],"type":"string"}}},"sheets_v4_TimeOfDay":{"description":"Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.","type":"object","properties":{"hours":{"description":"Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.","format":"int32","type":"integer"},"minutes":{"description":"Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.","format":"int32","type":"integer"},"nanos":{"description":"Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.","format":"int32","type":"integer"},"seconds":{"description":"Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.","format":"int32","type":"integer"}}},"sheets_v4_TreemapChartColorScale":{"description":"A color scale for a treemap chart.","type":"object","properties":{"maxValueColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"maxValueColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"midValueColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"midValueColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"minValueColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"minValueColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"noDataColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"noDataColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_TreemapChartSpec":{"description":"A Treemap chart.","type":"object","properties":{"colorData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"colorScale":{"$ref":"#/components/schemas/sheets_v4_TreemapChartColorScale"},"headerColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"headerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"hideTooltips":{"description":"True to hide tooltips.","type":"boolean"},"hintedLevels":{"description":"The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.","format":"int32","type":"integer"},"labels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"levels":{"description":"The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.","format":"int32","type":"integer"},"maxValue":{"description":"The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified.","format":"double","type":"number"},"minValue":{"description":"The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified.","format":"double","type":"number"},"parentLabels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"sizeData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"}}},"sheets_v4_TrimWhitespaceRequest":{"description":"Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range. This request removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space. If the resulting trimmed text starts with a '+' or '=' character, the text remains as a string value and isn't interpreted as a formula.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_TrimWhitespaceResponse":{"description":"The result of trimming whitespace in cells.","type":"object","properties":{"cellsChangedCount":{"description":"The number of cells that were trimmed of whitespace.","format":"int32","type":"integer"}}},"sheets_v4_UnmergeCellsRequest":{"description":"Unmerges cells in the given range.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_UpdateBandingRequest":{"description":"Updates properties of the supplied banded range.","type":"object","properties":{"bandedRange":{"$ref":"#/components/schemas/sheets_v4_BandedRange"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `bandedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateBordersRequest":{"description":"Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a border, explicitly set the style to NONE.","type":"object","properties":{"bottom":{"$ref":"#/components/schemas/sheets_v4_Border"},"innerHorizontal":{"$ref":"#/components/schemas/sheets_v4_Border"},"innerVertical":{"$ref":"#/components/schemas/sheets_v4_Border"},"left":{"$ref":"#/components/schemas/sheets_v4_Border"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"right":{"$ref":"#/components/schemas/sheets_v4_Border"},"top":{"$ref":"#/components/schemas/sheets_v4_Border"}}},"sheets_v4_UpdateCellsRequest":{"description":"Updates all cells in a range with new data.","type":"object","properties":{"fields":{"description":"The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rows":{"description":"The data to write.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RowData"}},"start":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"}}},"sheets_v4_UpdateChartSpecRequest":{"description":"Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)","type":"object","properties":{"chartId":{"description":"The ID of the chart to update.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_ChartSpec"}}},"sheets_v4_UpdateCommentPostRequest":{"description":"Updates a Post in a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"content":{"description":"The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Sheets editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"postId":{"description":"The ID of the post being updated.","type":"string"}}},"sheets_v4_UpdateConditionalFormatRuleRequest":{"description":"Updates a conditional format rule at the given index, or moves a conditional format rule to another index.","type":"object","properties":{"index":{"description":"The zero-based index of the rule that should be replaced or moved.","format":"int32","type":"integer"},"newIndex":{"description":"The zero-based new index the rule should end up at.","format":"int32","type":"integer"},"rule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"},"sheetId":{"description":"The sheet of the rule to move. Required if new_index is set, unused otherwise.","format":"int32","type":"integer"}}},"sheets_v4_UpdateConditionalFormatRuleResponse":{"description":"The result of updating a conditional format rule.","type":"object","properties":{"newIndex":{"description":"The index of the new rule.","format":"int32","type":"integer"},"newRule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"},"oldIndex":{"description":"The old index of the rule. Not set if a rule was replaced (because it is the same as new_index).","format":"int32","type":"integer"},"oldRule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}}},"sheets_v4_UpdateDataSourceRequest":{"description":"Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source.","type":"object","properties":{"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dataSource` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateDataSourceResponse":{"description":"The response from updating data source.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"}}},"sheets_v4_UpdateDeveloperMetadataRequest":{"description":"A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update.","type":"object","properties":{"dataFilters":{"description":"The filters matching the developer metadata entries to update.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `developerMetadata` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateDeveloperMetadataResponse":{"description":"The response from updating developer metadata.","type":"object","properties":{"developerMetadata":{"description":"The updated developer metadata.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}}},"sheets_v4_UpdateDimensionGroupRequest":{"description":"Updates the state of the specified group.","type":"object","properties":{"dimensionGroup":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dimensionGroup` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateDimensionPropertiesRequest":{"description":"Updates properties of dimensions within the specified range.","type":"object","properties":{"dataSourceSheetRange":{"$ref":"#/components/schemas/sheets_v4_DataSourceSheetDimensionRange"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"properties":{"$ref":"#/components/schemas/sheets_v4_DimensionProperties"},"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_UpdateEmbeddedObjectBorderRequest":{"description":"Updates an embedded object's border property.","type":"object","properties":{"border":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectBorder"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `border` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The ID of the embedded object to update.","format":"int32","type":"integer"}}},"sheets_v4_UpdateEmbeddedObjectPositionRequest":{"description":"Update an embedded object's position (such as a moving or resizing a chart or image).","type":"object","properties":{"fields":{"description":"The fields of OverlayPosition that should be updated when setting a new position. Used only if newPosition.overlayPosition is set, in which case at least one field must be specified. The root `newPosition.overlayPosition` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"newPosition":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"},"objectId":{"description":"The ID of the object to moved.","format":"int32","type":"integer"}}},"sheets_v4_UpdateEmbeddedObjectPositionResponse":{"description":"The result of updating an embedded object's position.","type":"object","properties":{"position":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"}}},"sheets_v4_UpdateFilterViewRequest":{"description":"Updates properties of the filter view.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `filter` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_UpdateNamedRangeRequest":{"description":"Updates properties of the named range with the specified namedRangeId.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `namedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"namedRange":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}}},"sheets_v4_UpdateProtectedRangeRequest":{"description":"Updates an existing protected range with the specified protectedRangeId.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `protectedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"protectedRange":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}}},"sheets_v4_UpdateSheetPropertiesRequest":{"description":"Updates properties of the sheet with the specified sheetId.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_UpdateSlicerSpecRequest":{"description":"Updates a slicer's specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `SlicerSpec` is implied and should not be specified. A single \"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"slicerId":{"description":"The id of the slicer to update.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_SlicerSpec"}}},"sheets_v4_UpdateSpreadsheetPropertiesRequest":{"description":"Updates properties of a spreadsheet.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root 'properties' is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"properties":{"$ref":"#/components/schemas/sheets_v4_SpreadsheetProperties"}}},"sheets_v4_UpdateTableRequest":{"description":"Updates a table in the spreadsheet.","type":"object","properties":{"fields":{"description":"Required. The fields that should be updated. At least one field must be specified. The root `table` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"table":{"$ref":"#/components/schemas/sheets_v4_Table"}}},"sheets_v4_UpdateValuesByDataFilterResponse":{"description":"The response when updating a range of values by a data filter in a spreadsheet.","type":"object","properties":{"dataFilter":{"$ref":"#/components/schemas/sheets_v4_DataFilter"},"updatedCells":{"description":"The number of cells updated.","format":"int32","type":"integer"},"updatedColumns":{"description":"The number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"updatedData":{"$ref":"#/components/schemas/sheets_v4_ValueRange"},"updatedRange":{"description":"The range (in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell)) that updates were applied to.","type":"string"},"updatedRows":{"description":"The number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"}}},"sheets_v4_UpdateValuesResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"updatedCells":{"description":"The number of cells updated.","format":"int32","type":"integer"},"updatedColumns":{"description":"The number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"updatedData":{"$ref":"#/components/schemas/sheets_v4_ValueRange"},"updatedRange":{"description":"The range (in A1 notation) that updates were applied to.","type":"string"},"updatedRows":{"description":"The number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"}}},"sheets_v4_ValueRange":{"description":"Data within a range of the spreadsheet.","type":"object","properties":{"majorDimension":{"description":"The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"range":{"description":"The range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.","type":"string"},"values":{"description":"The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.","type":"array","items":{"type":"array","items":{}}}}},"sheets_v4_WaterfallChartColumnStyle":{"description":"Styles for a waterfall chart column.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"label":{"description":"The label of the column's legend.","type":"string"}}},"sheets_v4_WaterfallChartCustomSubtotal":{"description":"A custom subtotal column for a waterfall chart series.","type":"object","properties":{"dataIsSubtotal":{"description":"True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point.","type":"boolean"},"label":{"description":"A label for the subtotal column.","type":"string"},"subtotalIndex":{"description":"The zero-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has three data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with.","format":"int32","type":"integer"}}},"sheets_v4_WaterfallChartDomain":{"description":"The domain of a waterfall chart.","type":"object","properties":{"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"reversed":{"description":"True to reverse the order of the domain values (horizontal axis).","type":"boolean"}}},"sheets_v4_WaterfallChartSeries":{"description":"A single series of data for a waterfall chart.","type":"object","properties":{"customSubtotals":{"description":"Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartCustomSubtotal"}},"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"dataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"},"hideTrailingSubtotal":{"description":"True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series.","type":"boolean"},"negativeColumnsStyle":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartColumnStyle"},"positiveColumnsStyle":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartColumnStyle"},"subtotalColumnsStyle":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartColumnStyle"}}},"sheets_v4_WaterfallChartSpec":{"description":"A waterfall chart.","type":"object","properties":{"connectorLineStyle":{"$ref":"#/components/schemas/sheets_v4_LineStyle"},"domain":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartDomain"},"firstValueIsTotal":{"description":"True to interpret the first value as a total.","type":"boolean"},"hideConnectorLines":{"description":"True to hide connector lines between columns.","type":"boolean"},"series":{"description":"The data this waterfall chart is visualizing.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartSeries"}},"stackedType":{"description":"The stacked type.","enum":["WATERFALL_STACKED_TYPE_UNSPECIFIED","STACKED","SEQUENTIAL"],"type":"string"},"totalDataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/spreadsheets":"","https://www.googleapis.com/auth/drive.file":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/sheets/v4/rest","service":"sheets","version":"v4"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Sheets API","version":"v4","description":"Reads and writes Google Sheets."},"servers":[{"url":"https://sheets.googleapis.com/"}],"paths":{"/v4/spreadsheets":{"post":{"operationId":"sheets.spreadsheets.create","x-executor-toolPath":"sheets.spreadsheets.create","tags":["Google Sheets API"],"description":"Creates a spreadsheet, returning the newly created spreadsheet.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}":{"get":{"operationId":"sheets.spreadsheets.get","x-executor-toolPath":"sheets.spreadsheets.get","tags":["Google Sheets API"],"description":"Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The spreadsheet to request.","schema":{"description":"The spreadsheet to request.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.","schema":{"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"excludeTablesInBandedRanges","in":"query","required":false,"description":"True if tables should be excluded in the banded ranges. False if not set.","schema":{"description":"True if tables should be excluded in the banded ranges. False if not set.","type":"boolean"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeGridData","in":"query","required":false,"description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request.","schema":{"description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"ranges","in":"query","required":false,"description":"The ranges to retrieve from the spreadsheet.","schema":{"type":"array","items":{"description":"The ranges to retrieve from the spreadsheet.","type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets.readonly","https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}":{"get":{"operationId":"sheets.spreadsheets.developerMetadata.get","x-executor-toolPath":"sheets.spreadsheets.developerMetadata.get","tags":["Google Sheets API"],"description":"Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve metadata from.","schema":{"description":"The ID of the spreadsheet to retrieve metadata from.","type":"string"}},{"name":"metadataId","in":"path","required":true,"description":"The ID of the developer metadata to retrieve.","schema":{"description":"The ID of the developer metadata to retrieve.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/developerMetadata:search":{"post":{"operationId":"sheets.spreadsheets.developerMetadata.search","x-executor-toolPath":"sheets.spreadsheets.developerMetadata.search","tags":["Google Sheets API"],"description":"Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve metadata from.","schema":{"description":"The ID of the spreadsheet to retrieve metadata from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_SearchDeveloperMetadataRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_SearchDeveloperMetadataResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo":{"post":{"operationId":"sheets.spreadsheets.sheets.copyTo","x-executor-toolPath":"sheets.spreadsheets.sheets.copyTo","tags":["Google Sheets API"],"description":"Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet containing the sheet to copy.","schema":{"description":"The ID of the spreadsheet containing the sheet to copy.","type":"string"}},{"name":"sheetId","in":"path","required":true,"description":"The ID of the sheet to copy.","schema":{"description":"The ID of the sheet to copy.","format":"int32","type":"integer"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_CopySheetToAnotherSpreadsheetRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}":{"get":{"operationId":"sheets.spreadsheets.values.get","x-executor-toolPath":"sheets.spreadsheets.values.get","tags":["Google Sheets API"],"description":"Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve data from.","schema":{"description":"The ID of the spreadsheet to retrieve data from.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","schema":{"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"dateTimeRenderOption","in":"query","required":false,"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"majorDimension","in":"query","required":false,"description":"The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","schema":{"description":"The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueRenderOption","in":"query","required":false,"description":"How values should be represented in the output. The default render option is FORMATTED_VALUE.","schema":{"description":"How values should be represented in the output. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets.readonly","https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]},"put":{"operationId":"sheets.spreadsheets.values.update","x-executor-toolPath":"sheets.spreadsheets.values.update","tags":["Google Sheets API"],"description":"Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update.","schema":{"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeValuesInResponse","in":"query","required":false,"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","schema":{"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"responseDateTimeRenderOption","in":"query","required":false,"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"responseValueRenderOption","in":"query","required":false,"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","schema":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueInputOption","in":"query","required":false,"description":"How the input data should be interpreted.","schema":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}:append":{"post":{"operationId":"sheets.spreadsheets.values.append","x-executor-toolPath":"sheets.spreadsheets.values.append","tags":["Google Sheets API"],"description":"Appends values to a spreadsheet. The input range is used to search for existing data and find a \"table\" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.","schema":{"description":"The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"includeValuesInResponse","in":"query","required":false,"description":"Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.","schema":{"description":"Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.","type":"boolean"},"style":"form","explode":false},{"name":"insertDataOption","in":"query","required":false,"description":"How the input data should be inserted.","schema":{"description":"How the input data should be inserted.","enum":["OVERWRITE","INSERT_ROWS"],"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"responseDateTimeRenderOption","in":"query","required":false,"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"responseValueRenderOption","in":"query","required":false,"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","schema":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueInputOption","in":"query","required":false,"description":"How the input data should be interpreted.","schema":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_AppendValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}:clear":{"post":{"operationId":"sheets.spreadsheets.values.clear","x-executor-toolPath":"sheets.spreadsheets.values.clear","tags":["Google Sheets API"],"description":"Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"range","in":"path","required":true,"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear.","schema":{"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ClearValuesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_ClearValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchClear":{"post":{"operationId":"sheets.spreadsheets.values.batchClear","x-executor-toolPath":"sheets.spreadsheets.values.batchClear","tags":["Google Sheets API"],"description":"Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter":{"post":{"operationId":"sheets.spreadsheets.values.batchClearByDataFilter","x-executor-toolPath":"sheets.spreadsheets.values.batchClearByDataFilter","tags":["Google Sheets API"],"description":"Clears one or more ranges of values from a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchClearValuesByDataFilterResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchGet":{"get":{"operationId":"sheets.spreadsheets.values.batchGet","x-executor-toolPath":"sheets.spreadsheets.values.batchGet","tags":["Google Sheets API"],"description":"Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve data from.","schema":{"description":"The ID of the spreadsheet to retrieve data from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"dateTimeRenderOption","in":"query","required":false,"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","schema":{"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"majorDimension","in":"query","required":false,"description":"The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","schema":{"description":"The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"ranges","in":"query","required":false,"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","schema":{"type":"array","items":{"description":"The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from.","type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"valueRenderOption","in":"query","required":false,"description":"How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.","schema":{"description":"How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchGetValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets.readonly","https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter":{"post":{"operationId":"sheets.spreadsheets.values.batchGetByDataFilter","x-executor-toolPath":"sheets.spreadsheets.values.batchGetByDataFilter","tags":["Google Sheets API"],"description":"Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to retrieve data from.","schema":{"description":"The ID of the spreadsheet to retrieve data from.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchGetValuesByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchGetValuesByDataFilterResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchUpdate":{"post":{"operationId":"sheets.spreadsheets.values.batchUpdate","x-executor-toolPath":"sheets.spreadsheets.values.batchUpdate","tags":["Google Sheets API"],"description":"Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter":{"post":{"operationId":"sheets.spreadsheets.values.batchUpdateByDataFilter","x-executor-toolPath":"sheets.spreadsheets.values.batchUpdateByDataFilter","tags":["Google Sheets API"],"description":"Sets values in one or more ranges of a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The ID of the spreadsheet to update.","schema":{"description":"The ID of the spreadsheet to update.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateValuesByDataFilterResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}:batchUpdate":{"post":{"operationId":"sheets.spreadsheets.batchUpdate","x-executor-toolPath":"sheets.spreadsheets.batchUpdate","tags":["Google Sheets API"],"description":"Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The spreadsheet to apply the updates to.","schema":{"description":"The spreadsheet to apply the updates to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateSpreadsheetRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_BatchUpdateSpreadsheetResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}},"/v4/spreadsheets/{spreadsheetId}:getByDataFilter":{"post":{"operationId":"sheets.spreadsheets.getByDataFilter","x-executor-toolPath":"sheets.spreadsheets.getByDataFilter","tags":["Google Sheets API"],"description":"Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP. * Set the includeGridData parameter to `true`. If a field mask is set, the `includeGridData` parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.","parameters":[{"name":"spreadsheetId","in":"path","required":true,"description":"The spreadsheet to request.","schema":{"description":"The spreadsheet to request.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_GetSpreadsheetByDataFilterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/spreadsheets"]},{"googleOAuth2":["https://www.googleapis.com/auth/drive.file"]}],"x-google-scopes":["https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}}},"components":{"schemas":{"sheets_v4_AddBandingRequest":{"description":"Adds a new banded range to the spreadsheet.","type":"object","properties":{"bandedRange":{"$ref":"#/components/schemas/sheets_v4_BandedRange"}}},"sheets_v4_AddBandingResponse":{"description":"The result of adding a banded range.","type":"object","properties":{"bandedRange":{"$ref":"#/components/schemas/sheets_v4_BandedRange"}}},"sheets_v4_AddChartRequest":{"description":"Adds a chart to a sheet in the spreadsheet.","type":"object","properties":{"chart":{"$ref":"#/components/schemas/sheets_v4_EmbeddedChart"}}},"sheets_v4_AddChartResponse":{"description":"The result of adding a chart to a spreadsheet.","type":"object","properties":{"chart":{"$ref":"#/components/schemas/sheets_v4_EmbeddedChart"}}},"sheets_v4_AddCommentReplyRequest":{"description":"Inserts a reply Post into a CommentThread.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread to add the reply to.","type":"string"},"post":{"$ref":"#/components/schemas/sheets_v4_Post"}}},"sheets_v4_AddCommentReplyResponse":{"description":"The result of creating a reply.","type":"object","properties":{"post":{"$ref":"#/components/schemas/sheets_v4_Post"}}},"sheets_v4_AddConditionalFormatRuleRequest":{"description":"Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented.","type":"object","properties":{"index":{"description":"The zero-based index where the rule should be inserted.","format":"int32","type":"integer"},"rule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}}},"sheets_v4_AddDataSourceRequest":{"description":"Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source.","type":"object","properties":{"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"}}},"sheets_v4_AddDataSourceResponse":{"description":"The result of adding a data source.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"}}},"sheets_v4_AddDimensionGroupRequest":{"description":"Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2].","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_AddDimensionGroupResponse":{"description":"The result of adding a group.","type":"object","properties":{"dimensionGroups":{"description":"All groups of a dimension after adding a group to that dimension.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}}}},"sheets_v4_AddFilterViewRequest":{"description":"Adds a filter view.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_AddFilterViewResponse":{"description":"The result of adding a filter view.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_AddNamedRangeRequest":{"description":"Adds a named range to the spreadsheet.","type":"object","properties":{"namedRange":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}}},"sheets_v4_AddNamedRangeResponse":{"description":"The result of adding a named range.","type":"object","properties":{"namedRange":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}}},"sheets_v4_AddProtectedRangeRequest":{"description":"Adds a new protected range.","type":"object","properties":{"protectedRange":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}}},"sheets_v4_AddProtectedRangeResponse":{"description":"The result of adding a new protected range.","type":"object","properties":{"protectedRange":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}}},"sheets_v4_AddSheetRequest":{"description":"Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_AddSheetResponse":{"description":"The result of adding a sheet.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_AddSlicerRequest":{"description":"Adds a slicer to a sheet in the spreadsheet.","type":"object","properties":{"slicer":{"$ref":"#/components/schemas/sheets_v4_Slicer"}}},"sheets_v4_AddSlicerResponse":{"description":"The result of adding a slicer to a spreadsheet.","type":"object","properties":{"slicer":{"$ref":"#/components/schemas/sheets_v4_Slicer"}}},"sheets_v4_AddTableRequest":{"description":"Adds a new table to the spreadsheet.","type":"object","properties":{"table":{"$ref":"#/components/schemas/sheets_v4_Table"}}},"sheets_v4_AddTableResponse":{"description":"The result of adding a table.","type":"object","properties":{"table":{"$ref":"#/components/schemas/sheets_v4_Table"}}},"sheets_v4_AppendCellsRequest":{"description":"Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.","type":"object","properties":{"fields":{"description":"The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"rows":{"description":"The data to append.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RowData"}},"sheetId":{"description":"The sheet ID to append the data to.","format":"int32","type":"integer"},"tableId":{"description":"The ID of the table to append data to. The data will be only appended to the table body. This field also takes precedence over the `sheet_id` field.","type":"string"}}},"sheets_v4_AppendDimensionRequest":{"description":"Appends rows or columns to the end of a sheet.","type":"object","properties":{"dimension":{"description":"Whether rows or columns should be appended.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"length":{"description":"The number of rows or columns to append.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet to append rows or columns to.","format":"int32","type":"integer"}}},"sheets_v4_AppendValuesResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"tableRange":{"description":"The range (in A1 notation) of the table that values are being appended to (before the values were appended). Empty if no table was found.","type":"string"},"updates":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesResponse"}}},"sheets_v4_AutoFillRequest":{"description":"Fills in more data based on existing data.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sourceAndDestination":{"$ref":"#/components/schemas/sheets_v4_SourceAndDestination"},"useAlternateSeries":{"description":"True if we should generate data with the \"alternate\" series. This differs based on the type and amount of source data.","type":"boolean"}}},"sheets_v4_AutoResizeDimensionsRequest":{"description":"Automatically resizes one or more dimensions based on the contents of the cells in that dimension.","type":"object","properties":{"dataSourceSheetDimensions":{"$ref":"#/components/schemas/sheets_v4_DataSourceSheetDimensionRange"},"dimensions":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_BandedRange":{"description":"A banded (alternating colors) range in a sheet.","type":"object","properties":{"bandedRangeId":{"description":"The ID of the banded range. If unset, refer to banded_range_reference.","format":"int32","type":"integer"},"bandedRangeReference":{"description":"Output only. The reference of the banded range, used to identify the ID that is not supported by the banded_range_id.","readOnly":true,"type":"string"},"columnProperties":{"$ref":"#/components/schemas/sheets_v4_BandingProperties"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rowProperties":{"$ref":"#/components/schemas/sheets_v4_BandingProperties"}}},"sheets_v4_BandingProperties":{"description":"Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.","type":"object","properties":{"firstBandColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"firstBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"footerColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"footerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"headerColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"headerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"secondBandColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"secondBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_BaselineValueFormat":{"description":"Formatting options for baseline value.","type":"object","properties":{"comparisonType":{"description":"The comparison type of key value with baseline value.","enum":["COMPARISON_TYPE_UNDEFINED","ABSOLUTE_DIFFERENCE","PERCENTAGE_DIFFERENCE"],"type":"string"},"description":{"description":"Description which is appended after the baseline value. This field is optional.","type":"string"},"negativeColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"negativeColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"position":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"positiveColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"positiveColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"}}},"sheets_v4_BasicChartAxis":{"description":"An axis of the chart. A chart may not have more than one axis per axis position.","type":"object","properties":{"format":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"position":{"description":"The position of this axis.","enum":["BASIC_CHART_AXIS_POSITION_UNSPECIFIED","BOTTOM_AXIS","LEFT_AXIS","RIGHT_AXIS"],"type":"string"},"title":{"description":"The title of this axis. If set, this overrides any title inferred from headers of the data.","type":"string"},"titleTextPosition":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"viewWindowOptions":{"$ref":"#/components/schemas/sheets_v4_ChartAxisViewWindowOptions"}}},"sheets_v4_BasicChartDomain":{"description":"The domain of a chart. For example, if charting stock prices over time, this would be the date.","type":"object","properties":{"domain":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"reversed":{"description":"True to reverse the order of the domain values (horizontal axis).","type":"boolean"}}},"sheets_v4_BasicChartSeries":{"description":"A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"dataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"},"lineStyle":{"$ref":"#/components/schemas/sheets_v4_LineStyle"},"pointStyle":{"$ref":"#/components/schemas/sheets_v4_PointStyle"},"series":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"styleOverrides":{"description":"Style override settings for series data points.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicSeriesDataPointStyleOverride"}},"targetAxis":{"description":"The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the \"Volume\" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type.","enum":["BASIC_CHART_AXIS_POSITION_UNSPECIFIED","BOTTOM_AXIS","LEFT_AXIS","RIGHT_AXIS"],"type":"string"},"type":{"description":"The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.","enum":["BASIC_CHART_TYPE_UNSPECIFIED","BAR","LINE","AREA","COLUMN","SCATTER","COMBO","STEPPED_AREA"],"type":"string"}}},"sheets_v4_BasicChartSpec":{"description":"The specification for a basic chart. See BasicChartType for the list of charts this supports.","type":"object","properties":{"axis":{"description":"The axis on the chart.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicChartAxis"}},"chartType":{"description":"The type of the chart.","enum":["BASIC_CHART_TYPE_UNSPECIFIED","BAR","LINE","AREA","COLUMN","SCATTER","COMBO","STEPPED_AREA"],"type":"string"},"compareMode":{"description":"The behavior of tooltips and data highlighting when hovering on data and chart area.","enum":["BASIC_CHART_COMPARE_MODE_UNSPECIFIED","DATUM","CATEGORY"],"type":"string"},"domains":{"description":"The domain of data this is charting. Only a single domain is supported.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicChartDomain"}},"headerCount":{"description":"The number of rows or columns in the data that are \"headers\". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.)","format":"int32","type":"integer"},"interpolateNulls":{"description":"If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.","type":"boolean"},"legendPosition":{"description":"The position of the chart legend.","enum":["BASIC_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND"],"type":"string"},"lineSmoothing":{"description":"Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.","type":"boolean"},"series":{"description":"The data this chart is visualizing.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BasicChartSeries"}},"stackedType":{"description":"The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.","enum":["BASIC_CHART_STACKED_TYPE_UNSPECIFIED","NOT_STACKED","STACKED","PERCENT_STACKED"],"type":"string"},"threeDimensional":{"description":"True to make the chart 3D. Applies to Bar and Column charts.","type":"boolean"},"totalDataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"}}},"sheets_v4_BasicFilter":{"description":"The default filter associated with a sheet. For more information, see [Manage data visibility with filters](https://developers.google.com/workspace/sheets/api/guides/filters).","type":"object","properties":{"criteria":{"description":"The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.","type":"object","additionalProperties":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"}},"filterSpecs":{"description":"The filter criteria per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sortSpecs":{"description":"The sort order per column. Later specifications are used when values are equal in the earlier specifications.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}},"tableId":{"description":"The table this filter is backed by, if any. When writing, only one of range or table_id may be set.","type":"string"}}},"sheets_v4_BasicSeriesDataPointStyleOverride":{"description":"Style override settings for a single series data point.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"index":{"description":"The zero-based index of the series data point.","format":"int32","type":"integer"},"pointStyle":{"$ref":"#/components/schemas/sheets_v4_PointStyle"}}},"sheets_v4_BatchClearValuesByDataFilterRequest":{"description":"The request for clearing more than one range selected by a DataFilter in a spreadsheet.","type":"object","properties":{"dataFilters":{"description":"The DataFilters used to determine which ranges to clear.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}}}},"sheets_v4_BatchClearValuesByDataFilterResponse":{"description":"The response when clearing a range of values selected with DataFilters in a spreadsheet.","type":"object","properties":{"clearedRanges":{"description":"The ranges that were cleared, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a range larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.","type":"array","items":{"type":"string"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"}}},"sheets_v4_BatchClearValuesRequest":{"description":"The request for clearing more than one range of values in a spreadsheet.","type":"object","properties":{"ranges":{"description":"The ranges to clear, in [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell).","type":"array","items":{"type":"string"}}}},"sheets_v4_BatchClearValuesResponse":{"description":"The response when clearing a range of values in a spreadsheet.","type":"object","properties":{"clearedRanges":{"description":"The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a range larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.","type":"array","items":{"type":"string"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"}}},"sheets_v4_BatchGetValuesByDataFilterRequest":{"description":"The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.","type":"object","properties":{"dataFilters":{"description":"The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"dateTimeRenderOption":{"description":"How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"majorDimension":{"description":"The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"valueRenderOption":{"description":"How values should be represented in the output. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"}}},"sheets_v4_BatchGetValuesByDataFilterResponse":{"description":"The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.","type":"object","properties":{"spreadsheetId":{"description":"The ID of the spreadsheet the data was retrieved from.","type":"string"},"valueRanges":{"description":"The requested values with the list of data filters that matched them.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_MatchedValueRange"}}}},"sheets_v4_BatchGetValuesResponse":{"description":"The response when retrieving more than one range of values in a spreadsheet.","type":"object","properties":{"spreadsheetId":{"description":"The ID of the spreadsheet the data was retrieved from.","type":"string"},"valueRanges":{"description":"The requested values. The order of the ValueRanges is the same as the order of the requested ranges.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}}},"sheets_v4_BatchUpdateSpreadsheetRequest":{"description":"The request for updating any aspect of a spreadsheet.","type":"object","properties":{"commentsViewMode":{"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. Meaningful only if include_spreadsheet_in_response is 'true'.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"includeSpreadsheetInResponse":{"description":"Determines if the update response should include the spreadsheet resource.","type":"boolean"},"requests":{"description":"A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Request"}},"responseIncludeGridData":{"description":"True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.","type":"boolean"},"responseRanges":{"description":"Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.","type":"array","items":{"type":"string"}}}},"sheets_v4_BatchUpdateSpreadsheetResponse":{"description":"The reply for batch updating a spreadsheet.","type":"object","properties":{"commentUpdateState":{"description":"Whether comment updates were applied in the batch request.","enum":["COMMENT_UPDATE_STATE_UNSPECIFIED","NO_UPDATES_REQUESTED","ALL_SAVED","ALL_FAILED_UNKNOWN_REASON"],"type":"string"},"replies":{"description":"The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Response"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"updatedSpreadsheet":{"$ref":"#/components/schemas/sheets_v4_Spreadsheet"}}},"sheets_v4_BatchUpdateValuesByDataFilterRequest":{"description":"The request for updating more than one range of values in a spreadsheet.","type":"object","properties":{"data":{"description":"The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilterValueRange"}},"includeValuesInResponse":{"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","type":"boolean"},"responseDateTimeRenderOption":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"responseValueRenderOption":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"valueInputOption":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"}}},"sheets_v4_BatchUpdateValuesByDataFilterResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"responses":{"description":"The response for each range updated.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesByDataFilterResponse"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"totalUpdatedCells":{"description":"The total number of cells updated.","format":"int32","type":"integer"},"totalUpdatedColumns":{"description":"The total number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"totalUpdatedRows":{"description":"The total number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"},"totalUpdatedSheets":{"description":"The total number of sheets where at least one cell in the sheet was updated.","format":"int32","type":"integer"}}},"sheets_v4_BatchUpdateValuesRequest":{"description":"The request for updating more than one range of values in a spreadsheet.","type":"object","properties":{"data":{"description":"The new values to apply to the spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}},"includeValuesInResponse":{"description":"Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).","type":"boolean"},"responseDateTimeRenderOption":{"description":"Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.","enum":["SERIAL_NUMBER","FORMATTED_STRING"],"type":"string"},"responseValueRenderOption":{"description":"Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.","enum":["FORMATTED_VALUE","UNFORMATTED_VALUE","FORMULA"],"type":"string"},"valueInputOption":{"description":"How the input data should be interpreted.","enum":["INPUT_VALUE_OPTION_UNSPECIFIED","RAW","USER_ENTERED"],"type":"string"}}},"sheets_v4_BatchUpdateValuesResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"responses":{"description":"One UpdateValuesResponse per requested range, in the same order as the requests appeared.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_UpdateValuesResponse"}},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"totalUpdatedCells":{"description":"The total number of cells updated.","format":"int32","type":"integer"},"totalUpdatedColumns":{"description":"The total number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"totalUpdatedRows":{"description":"The total number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"},"totalUpdatedSheets":{"description":"The total number of sheets where at least one cell in the sheet was updated.","format":"int32","type":"integer"}}},"sheets_v4_BigQueryDataSourceSpec":{"description":"The specification of a BigQuery data source that's connected to a sheet.","type":"object","properties":{"projectId":{"description":"The ID of a BigQuery enabled Google Cloud project with a billing account attached. For any queries executed against the data source, the project is charged.","type":"string"},"querySpec":{"$ref":"#/components/schemas/sheets_v4_BigQueryQuerySpec"},"tableSpec":{"$ref":"#/components/schemas/sheets_v4_BigQueryTableSpec"}}},"sheets_v4_BigQueryQuerySpec":{"description":"Specifies a custom BigQuery query.","type":"object","properties":{"rawQuery":{"description":"The raw query string.","type":"string"}}},"sheets_v4_BigQueryTableSpec":{"description":"Specifies a BigQuery table definition. Only [native tables](https://cloud.google.com/bigquery/docs/tables-intro) are allowed.","type":"object","properties":{"datasetId":{"description":"The BigQuery dataset id.","type":"string"},"tableId":{"description":"The BigQuery table id.","type":"string"},"tableProjectId":{"description":"The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed.","type":"string"}}},"sheets_v4_BooleanCondition":{"description":"A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.","type":"object","properties":{"type":{"description":"The type of condition.","enum":["CONDITION_TYPE_UNSPECIFIED","NUMBER_GREATER","NUMBER_GREATER_THAN_EQ","NUMBER_LESS","NUMBER_LESS_THAN_EQ","NUMBER_EQ","NUMBER_NOT_EQ","NUMBER_BETWEEN","NUMBER_NOT_BETWEEN","TEXT_CONTAINS","TEXT_NOT_CONTAINS","TEXT_STARTS_WITH","TEXT_ENDS_WITH","TEXT_EQ","TEXT_IS_EMAIL","TEXT_IS_URL","DATE_EQ","DATE_BEFORE","DATE_AFTER","DATE_ON_OR_BEFORE","DATE_ON_OR_AFTER","DATE_BETWEEN","DATE_NOT_BETWEEN","DATE_IS_VALID","ONE_OF_RANGE","ONE_OF_LIST","BLANK","NOT_BLANK","CUSTOM_FORMULA","BOOLEAN","TEXT_NOT_EQ","DATE_NOT_EQ","FILTER_EXPRESSION"],"type":"string"},"values":{"description":"The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ConditionValue"}}}},"sheets_v4_BooleanRule":{"description":"A rule that may or may not match, depending on the condition.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"format":{"$ref":"#/components/schemas/sheets_v4_CellFormat"}}},"sheets_v4_Border":{"description":"A border along a cell.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"style":{"description":"The style of the border.","enum":["STYLE_UNSPECIFIED","DOTTED","DASHED","SOLID","SOLID_MEDIUM","SOLID_THICK","NONE","DOUBLE"],"type":"string"},"width":{"description":"The width of the border, in pixels. Deprecated; the width is determined by the \"style\" field.","format":"int32","type":"integer"}}},"sheets_v4_Borders":{"description":"The borders of the cell.","type":"object","properties":{"bottom":{"$ref":"#/components/schemas/sheets_v4_Border"},"left":{"$ref":"#/components/schemas/sheets_v4_Border"},"right":{"$ref":"#/components/schemas/sheets_v4_Border"},"top":{"$ref":"#/components/schemas/sheets_v4_Border"}}},"sheets_v4_BubbleChartSpec":{"description":"A bubble chart.","type":"object","properties":{"bubbleBorderColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"bubbleBorderColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"bubbleLabels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"bubbleMaxRadiusSize":{"description":"The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.","format":"int32","type":"integer"},"bubbleMinRadiusSize":{"description":"The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.","format":"int32","type":"integer"},"bubbleOpacity":{"description":"The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.","format":"float","type":"number"},"bubbleSizes":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"bubbleTextStyle":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"domain":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"groupIds":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"legendPosition":{"description":"Where the legend of the chart should be drawn.","enum":["BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND","INSIDE_LEGEND"],"type":"string"},"series":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_CancelDataSourceRefreshRequest":{"description":"Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.","type":"object","properties":{"dataSourceId":{"description":"Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source.","type":"string"},"isAll":{"description":"Cancels all existing data source object refreshes for all data sources in the spreadsheet.","type":"boolean"},"references":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReferences"}}},"sheets_v4_CancelDataSourceRefreshResponse":{"description":"The response from cancelling one or multiple data source object refreshes.","type":"object","properties":{"statuses":{"description":"The cancellation statuses of refreshes of all data source objects specified in the request. If is_all is specified, the field contains only those in failure status. Refreshing and canceling refresh the same data source object is also not allowed in the same `batchUpdate`.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CancelDataSourceRefreshStatus"}}}},"sheets_v4_CancelDataSourceRefreshStatus":{"description":"The status of cancelling a single data source object refresh.","type":"object","properties":{"reference":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReference"},"refreshCancellationStatus":{"$ref":"#/components/schemas/sheets_v4_RefreshCancellationStatus"}}},"sheets_v4_CandlestickChartSpec":{"description":"A candlestick chart.","type":"object","properties":{"data":{"description":"The Candlestick chart data. Only one CandlestickData is supported.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CandlestickData"}},"domain":{"$ref":"#/components/schemas/sheets_v4_CandlestickDomain"}}},"sheets_v4_CandlestickData":{"description":"The Candlestick chart data, each containing the low, open, close, and high values for a series.","type":"object","properties":{"closeSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"},"highSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"},"lowSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"},"openSeries":{"$ref":"#/components/schemas/sheets_v4_CandlestickSeries"}}},"sheets_v4_CandlestickDomain":{"description":"The domain of a CandlestickChart.","type":"object","properties":{"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"reversed":{"description":"True to reverse the order of the domain values (horizontal axis).","type":"boolean"}}},"sheets_v4_CandlestickSeries":{"description":"The series of a CandlestickData.","type":"object","properties":{"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_CellData":{"description":"Data about a specific cell.","type":"object","properties":{"chipRuns":{"description":"Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty Chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ChipRun"}},"dataSourceFormula":{"$ref":"#/components/schemas/sheets_v4_DataSourceFormula"},"dataSourceTable":{"$ref":"#/components/schemas/sheets_v4_DataSourceTable"},"dataValidation":{"$ref":"#/components/schemas/sheets_v4_DataValidationRule"},"effectiveFormat":{"$ref":"#/components/schemas/sheets_v4_CellFormat"},"effectiveValue":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"},"formattedValue":{"description":"The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.","type":"string"},"hyperlink":{"description":"A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field. A cell-level link can also be set from the userEnteredFormat.textFormat field. Alternatively, set a hyperlink in the textFormatRun.format.link field that spans the entire cell.","type":"string"},"note":{"description":"Any note on the cell.","type":"string"},"pivotTable":{"$ref":"#/components/schemas/sheets_v4_PivotTable"},"textFormatRuns":{"description":"Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of the cell unless explicitly changed. When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_TextFormatRun"}},"userEnteredFormat":{"$ref":"#/components/schemas/sheets_v4_CellFormat"},"userEnteredValue":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}}},"sheets_v4_CellFormat":{"description":"The format of a cell.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"borders":{"$ref":"#/components/schemas/sheets_v4_Borders"},"horizontalAlignment":{"description":"The horizontal alignment of the value in the cell.","enum":["HORIZONTAL_ALIGN_UNSPECIFIED","LEFT","CENTER","RIGHT"],"type":"string"},"hyperlinkDisplayType":{"description":"If one exists, how a hyperlink should be displayed in the cell.","enum":["HYPERLINK_DISPLAY_TYPE_UNSPECIFIED","LINKED","PLAIN_TEXT"],"type":"string"},"numberFormat":{"$ref":"#/components/schemas/sheets_v4_NumberFormat"},"padding":{"$ref":"#/components/schemas/sheets_v4_Padding"},"textDirection":{"description":"The direction of the text in the cell.","enum":["TEXT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"textRotation":{"$ref":"#/components/schemas/sheets_v4_TextRotation"},"verticalAlignment":{"description":"The vertical alignment of the value in the cell.","enum":["VERTICAL_ALIGN_UNSPECIFIED","TOP","MIDDLE","BOTTOM"],"type":"string"},"wrapStrategy":{"description":"The wrap strategy for the value in the cell.","enum":["WRAP_STRATEGY_UNSPECIFIED","OVERFLOW_CELL","LEGACY_WRAP","CLIP","WRAP"],"type":"string"}}},"sheets_v4_ChartAxisViewWindowOptions":{"description":"The options that define a \"view window\" for a chart (such as the visible values in an axis).","type":"object","properties":{"viewWindowMax":{"description":"The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data.","format":"double","type":"number"},"viewWindowMin":{"description":"The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data.","format":"double","type":"number"},"viewWindowMode":{"description":"The view window's mode.","enum":["DEFAULT_VIEW_WINDOW_MODE","VIEW_WINDOW_MODE_UNSUPPORTED","EXPLICIT","PRETTY"],"type":"string"}}},"sheets_v4_ChartCustomNumberFormatOptions":{"description":"Custom number formatting options for chart attributes.","type":"object","properties":{"prefix":{"description":"Custom prefix to be prepended to the chart attribute. This field is optional.","type":"string"},"suffix":{"description":"Custom suffix to be appended to the chart attribute. This field is optional.","type":"string"}}},"sheets_v4_ChartData":{"description":"The data included in a domain or series.","type":"object","properties":{"aggregateType":{"description":"The aggregation type for the series of a data source chart. Only supported for data source charts.","enum":["CHART_AGGREGATE_TYPE_UNSPECIFIED","AVERAGE","COUNT","MAX","MEDIAN","MIN","SUM"],"type":"string"},"columnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"groupRule":{"$ref":"#/components/schemas/sheets_v4_ChartGroupRule"},"sourceRange":{"$ref":"#/components/schemas/sheets_v4_ChartSourceRange"}}},"sheets_v4_ChartDateTimeRule":{"description":"Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values.","type":"object","properties":{"type":{"description":"The type of date-time grouping to apply.","enum":["CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED","SECOND","MINUTE","HOUR","HOUR_MINUTE","HOUR_MINUTE_AMPM","DAY_OF_WEEK","DAY_OF_YEAR","DAY_OF_MONTH","DAY_MONTH","MONTH","QUARTER","YEAR","YEAR_MONTH","YEAR_QUARTER","YEAR_MONTH_DAY"],"type":"string"}}},"sheets_v4_ChartGroupRule":{"description":"An optional setting on the ChartData of the domain of a data source chart that defines buckets for the values in the domain rather than breaking out each individual value. For example, when plotting a data source chart, you can specify a histogram rule on the domain (it should only contain numeric values), grouping its values into buckets. Any values of a chart series that fall into the same bucket are aggregated based on the aggregate_type.","type":"object","properties":{"dateTimeRule":{"$ref":"#/components/schemas/sheets_v4_ChartDateTimeRule"},"histogramRule":{"$ref":"#/components/schemas/sheets_v4_ChartHistogramRule"}}},"sheets_v4_ChartHistogramRule":{"description":"Allows you to organize numeric values in a source data column into buckets of constant size.","type":"object","properties":{"intervalSize":{"description":"The size of the buckets that are created. Must be positive.","format":"double","type":"number"},"maxValue":{"description":"The maximum value at which items are placed into buckets. Values greater than the maximum are grouped into a single bucket. If omitted, it is determined by the maximum item value.","format":"double","type":"number"},"minValue":{"description":"The minimum value at which items are placed into buckets. Values that are less than the minimum are grouped into a single bucket. If omitted, it is determined by the minimum item value.","format":"double","type":"number"}}},"sheets_v4_ChartSourceRange":{"description":"Source ranges for a chart.","type":"object","properties":{"sources":{"description":"The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more than one source range, then the source range at a given offset must be in order and contiguous across the domain and series. For example, these are valid configurations: domain sources: A1:A5 series1 sources: B1:B5 series2 sources: D6:D10 domain sources: A1:A5, C10:C12 series1 sources: B1:B5, D10:D12 series2 sources: C1:C5, E10:E12","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}}},"sheets_v4_ChartSpec":{"description":"The specifications of a chart.","type":"object","properties":{"altText":{"description":"The alternative text that describes the chart. This is often used for accessibility.","type":"string"},"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"basicChart":{"$ref":"#/components/schemas/sheets_v4_BasicChartSpec"},"bubbleChart":{"$ref":"#/components/schemas/sheets_v4_BubbleChartSpec"},"candlestickChart":{"$ref":"#/components/schemas/sheets_v4_CandlestickChartSpec"},"dataSourceChartProperties":{"$ref":"#/components/schemas/sheets_v4_DataSourceChartProperties"},"filterSpecs":{"description":"The filters applied to the source data of the chart. Only supported for data source charts.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"fontName":{"description":"The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.","type":"string"},"hiddenDimensionStrategy":{"description":"Determines how the charts will use hidden rows or columns.","enum":["CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED","SKIP_HIDDEN_ROWS_AND_COLUMNS","SKIP_HIDDEN_ROWS","SKIP_HIDDEN_COLUMNS","SHOW_ALL"],"type":"string"},"histogramChart":{"$ref":"#/components/schemas/sheets_v4_HistogramChartSpec"},"maximized":{"description":"True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)","type":"boolean"},"orgChart":{"$ref":"#/components/schemas/sheets_v4_OrgChartSpec"},"pieChart":{"$ref":"#/components/schemas/sheets_v4_PieChartSpec"},"scorecardChart":{"$ref":"#/components/schemas/sheets_v4_ScorecardChartSpec"},"sortSpecs":{"description":"The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}},"subtitle":{"description":"The subtitle of the chart.","type":"string"},"subtitleTextFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"subtitleTextPosition":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"title":{"description":"The title of the chart.","type":"string"},"titleTextFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"titleTextPosition":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"treemapChart":{"$ref":"#/components/schemas/sheets_v4_TreemapChartSpec"},"waterfallChart":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartSpec"}}},"sheets_v4_Chip":{"description":"The Smart Chip.","type":"object","properties":{"personProperties":{"$ref":"#/components/schemas/sheets_v4_PersonProperties"},"richLinkProperties":{"$ref":"#/components/schemas/sheets_v4_RichLinkProperties"}}},"sheets_v4_ChipRun":{"description":"The run of a chip. The chip continues until the start index of the next run.","type":"object","properties":{"chip":{"$ref":"#/components/schemas/sheets_v4_Chip"},"startIndex":{"description":"Required. The zero-based character index where this run starts, in UTF-16 code units.","format":"int32","type":"integer"}}},"sheets_v4_ClearBasicFilterRequest":{"description":"Clears the basic filter, if any exists on the sheet.","type":"object","properties":{"sheetId":{"description":"The sheet ID on which the basic filter should be cleared.","format":"int32","type":"integer"}}},"sheets_v4_ClearValuesRequest":{"description":"The request for clearing a range of values in a spreadsheet.","type":"object"},"sheets_v4_ClearValuesResponse":{"description":"The response when clearing a range of values in a spreadsheet.","type":"object","properties":{"clearedRange":{"description":"The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a range larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet's limits.)","type":"string"},"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"}}},"sheets_v4_Color":{"description":"Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...","type":"object","properties":{"alpha":{"description":"The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).","format":"float","type":"number"},"blue":{"description":"The amount of blue in the color as a value in the interval [0, 1].","format":"float","type":"number"},"green":{"description":"The amount of green in the color as a value in the interval [0, 1].","format":"float","type":"number"},"red":{"description":"The amount of red in the color as a value in the interval [0, 1].","format":"float","type":"number"}}},"sheets_v4_ColorStyle":{"description":"A color value.","type":"object","properties":{"rgbColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"themeColor":{"description":"Theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","TEXT","BACKGROUND","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","LINK"],"type":"string"}}},"sheets_v4_CommentAnchor":{"description":"A location in the spreadsheet that is tied to a CommentThread with the same anchorId. Note: Multiple anchors may refer to the same location.","type":"object","properties":{"anchorId":{"description":"The unique ID of the comment anchor. Output only.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_CommentThread":{"description":"Represents a single comment thread inside a spreadsheet.","type":"object","properties":{"anchorId":{"description":"The ID of the CommentAnchor in the sheet that this thread is tied to.","type":"string"},"commentId":{"description":"The unique ID of the comment thread.","type":"string"},"headPost":{"$ref":"#/components/schemas/sheets_v4_Post"},"plainTextQuote":{"description":"The quoted text from the spreadsheet when the comment was created, formatted as plain-text.","type":"string"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Post"}},"status":{"description":"Whether the thread is open or resolved.","enum":["STATUS_UNSPECIFIED","OPEN","RESOLVED"],"type":"string"}}},"sheets_v4_ConditionValue":{"description":"The value of the condition.","type":"object","properties":{"relativeDate":{"description":"A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters.","enum":["RELATIVE_DATE_UNSPECIFIED","PAST_YEAR","PAST_MONTH","PAST_WEEK","YESTERDAY","TODAY","TOMORROW"],"type":"string"},"userEnteredValue":{"description":"A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+').","type":"string"}}},"sheets_v4_ConditionalFormatRule":{"description":"A rule describing a conditional format.","type":"object","properties":{"booleanRule":{"$ref":"#/components/schemas/sheets_v4_BooleanRule"},"gradientRule":{"$ref":"#/components/schemas/sheets_v4_GradientRule"},"ranges":{"description":"The ranges that are formatted if the condition is true. All the ranges must be on the same grid.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}}},"sheets_v4_CopyPasteRequest":{"description":"Copies data from the source to the destination.","type":"object","properties":{"destination":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"pasteOrientation":{"description":"How that data should be oriented when pasting.","enum":["NORMAL","TRANSPOSE"],"type":"string"},"pasteType":{"description":"What kind of data to paste.","enum":["PASTE_NORMAL","PASTE_VALUES","PASTE_FORMAT","PASTE_NO_BORDERS","PASTE_FORMULA","PASTE_DATA_VALIDATION","PASTE_CONDITIONAL_FORMATTING"],"type":"string"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_CopySheetToAnotherSpreadsheetRequest":{"description":"The request to copy a sheet across spreadsheets.","type":"object","properties":{"destinationSpreadsheetId":{"description":"The ID of the spreadsheet to copy the sheet to.","type":"string"}}},"sheets_v4_CreateDeveloperMetadataRequest":{"description":"A request to create developer metadata.","type":"object","properties":{"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}},"sheets_v4_CreateDeveloperMetadataResponse":{"description":"The response from creating developer metadata.","type":"object","properties":{"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}},"sheets_v4_CutPasteRequest":{"description":"Moves data from the source to the destination.","type":"object","properties":{"destination":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"pasteType":{"description":"What kind of data to paste. All the source data will be cut, regardless of what is pasted.","enum":["PASTE_NORMAL","PASTE_VALUES","PASTE_FORMAT","PASTE_NO_BORDERS","PASTE_FORMULA","PASTE_DATA_VALIDATION","PASTE_CONDITIONAL_FORMATTING"],"type":"string"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DataExecutionStatus":{"description":"The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects.","type":"object","properties":{"errorCode":{"description":"The error code.","enum":["DATA_EXECUTION_ERROR_CODE_UNSPECIFIED","TIMED_OUT","TOO_MANY_ROWS","TOO_MANY_COLUMNS","TOO_MANY_CELLS","ENGINE","PARAMETER_INVALID","UNSUPPORTED_DATA_TYPE","DUPLICATE_COLUMN_NAMES","INTERRUPTED","CONCURRENT_QUERY","OTHER","TOO_MANY_CHARS_PER_CELL","DATA_NOT_FOUND","PERMISSION_DENIED","MISSING_COLUMN_ALIAS","OBJECT_NOT_FOUND","OBJECT_IN_ERROR_STATE","OBJECT_SPEC_INVALID","DATA_EXECUTION_CANCELLED"],"type":"string"},"errorMessage":{"description":"The error message, which may be empty.","type":"string"},"lastRefreshTime":{"description":"Gets the time the data last successfully refreshed.","format":"google-datetime","type":"string"},"state":{"description":"The state of the data execution.","enum":["DATA_EXECUTION_STATE_UNSPECIFIED","NOT_STARTED","RUNNING","CANCELLING","SUCCEEDED","FAILED"],"type":"string"}}},"sheets_v4_DataFilter":{"description":"Filter that describes what data should be selected or returned from a request. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).","type":"object","properties":{"a1Range":{"description":"Selects data that matches the specified A1 range.","type":"string"},"developerMetadataLookup":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadataLookup"},"gridRange":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DataFilterValueRange":{"description":"A range of values whose location is specified by a DataFilter.","type":"object","properties":{"dataFilter":{"$ref":"#/components/schemas/sheets_v4_DataFilter"},"majorDimension":{"description":"The major dimension of the values.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"values":{"description":"The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request fails. If the provided values are less than the matched ranges only the specified values are written, existing values in the matched ranges remain unaffected.","type":"array","items":{"type":"array","items":{}}}}},"sheets_v4_DataLabel":{"description":"Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.","type":"object","properties":{"customLabelData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"placement":{"description":"The placement of the data label relative to the labeled data.","enum":["DATA_LABEL_PLACEMENT_UNSPECIFIED","CENTER","LEFT","RIGHT","ABOVE","BELOW","INSIDE_END","INSIDE_BASE","OUTSIDE_END"],"type":"string"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"type":{"description":"The type of the data label.","enum":["DATA_LABEL_TYPE_UNSPECIFIED","NONE","DATA","CUSTOM"],"type":"string"}}},"sheets_v4_DataSource":{"description":"Information about an external data source in the spreadsheet.","type":"object","properties":{"calculatedColumns":{"description":"All calculated columns in the data source.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumn"}},"dataSourceId":{"description":"The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365.","type":"string"},"sheetId":{"description":"The ID of the Sheet connected with the data source. The field cannot be changed once set. When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_DataSourceSpec"}}},"sheets_v4_DataSourceChartProperties":{"description":"Properties of a data source chart.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"ID of the data source that the chart is associated with.","type":"string"}}},"sheets_v4_DataSourceColumn":{"description":"A column in a data source.","type":"object","properties":{"formula":{"description":"The formula of the calculated column.","type":"string"},"reference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"}}},"sheets_v4_DataSourceColumnReference":{"description":"An unique identifier that references a data source column.","type":"object","properties":{"name":{"description":"The display name of the column. It should be unique within a data source.","type":"string"}}},"sheets_v4_DataSourceFormula":{"description":"A data source formula.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"The ID of the data source the formula is associated with.","type":"string"}}},"sheets_v4_DataSourceObjectReference":{"description":"Reference to a data source object.","type":"object","properties":{"chartId":{"description":"References to a data source chart.","format":"int32","type":"integer"},"dataSourceFormulaCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"dataSourcePivotTableAnchorCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"dataSourceTableAnchorCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"sheetId":{"description":"References to a DATA_SOURCE sheet.","type":"string"}}},"sheets_v4_DataSourceObjectReferences":{"description":"A list of references to data source objects.","type":"object","properties":{"references":{"description":"The references.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReference"}}}},"sheets_v4_DataSourceParameter":{"description":"A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.","type":"object","properties":{"name":{"description":"Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers).","type":"string"},"namedRangeId":{"description":"ID of a NamedRange. Its size must be 1x1.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DataSourceRefreshDailySchedule":{"description":"A schedule for data to refresh every day in a given time interval.","type":"object","properties":{"startTime":{"$ref":"#/components/schemas/sheets_v4_TimeOfDay"}}},"sheets_v4_DataSourceRefreshMonthlySchedule":{"description":"A monthly schedule for data to refresh on specific days in the month in a given time interval.","type":"object","properties":{"daysOfMonth":{"description":"Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At least one day must be specified.","type":"array","items":{"format":"int32","type":"integer"}},"startTime":{"$ref":"#/components/schemas/sheets_v4_TimeOfDay"}}},"sheets_v4_DataSourceRefreshSchedule":{"description":"Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day.","type":"object","properties":{"dailySchedule":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshDailySchedule"},"enabled":{"description":"True if the refresh schedule is enabled, or false otherwise.","type":"boolean"},"monthlySchedule":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshMonthlySchedule"},"nextRun":{"$ref":"#/components/schemas/sheets_v4_Interval"},"refreshScope":{"description":"The scope of the refresh. Must be ALL_DATA_SOURCES.","enum":["DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED","ALL_DATA_SOURCES"],"type":"string"},"weeklySchedule":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshWeeklySchedule"}}},"sheets_v4_DataSourceRefreshWeeklySchedule":{"description":"A weekly schedule for data to refresh on specific days in a given time interval.","type":"object","properties":{"daysOfWeek":{"description":"Days of the week to refresh. At least one day must be specified.","type":"array","items":{"enum":["DAY_OF_WEEK_UNSPECIFIED","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"}},"startTime":{"$ref":"#/components/schemas/sheets_v4_TimeOfDay"}}},"sheets_v4_DataSourceSheetDimensionRange":{"description":"A range along a single dimension on a DATA_SOURCE sheet.","type":"object","properties":{"columnReferences":{"description":"The columns on the data source sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"}},"sheetId":{"description":"The ID of the data source sheet the range is on.","format":"int32","type":"integer"}}},"sheets_v4_DataSourceSheetProperties":{"description":"Additional properties of a DATA_SOURCE sheet.","type":"object","properties":{"columns":{"description":"The columns displayed on the sheet, corresponding to the values in RowData.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumn"}},"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"ID of the DataSource the sheet is connected to.","type":"string"}}},"sheets_v4_DataSourceSpec":{"description":"This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.","type":"object","properties":{"bigQuery":{"$ref":"#/components/schemas/sheets_v4_BigQueryDataSourceSpec"},"looker":{"$ref":"#/components/schemas/sheets_v4_LookerDataSourceSpec"},"parameters":{"description":"The parameters of the data source, used when querying the data source.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceParameter"}}}},"sheets_v4_DataSourceTable":{"description":"A data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as \"Extract\" in the Sheets editor.","type":"object","properties":{"columnSelectionType":{"description":"The type to select columns for the data source table. Defaults to SELECTED.","enum":["DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED","SELECTED","SYNC_ALL"],"type":"string"},"columns":{"description":"Columns selected for the data source table. The column_selection_type must be SELECTED.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"}},"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"The ID of the data source the data source table is associated with.","type":"string"},"filterSpecs":{"description":"Filter specifications in the data source table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"rowLimit":{"description":"The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit.","format":"int32","type":"integer"},"sortSpecs":{"description":"Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}}}},"sheets_v4_DataValidationRule":{"description":"A data validation rule.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"inputMessage":{"description":"A message to show the user when adding data to the cell.","type":"string"},"showCustomUi":{"description":"True if the UI should be customized based on the kind of condition. If true, \"List\" conditions will show a dropdown.","type":"boolean"},"strict":{"description":"True if invalid data should be rejected.","type":"boolean"}}},"sheets_v4_DateTimeRule":{"description":"Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+--------------+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +--------------+--------------+ | Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +--------------+--------------+","type":"object","properties":{"type":{"description":"The type of date-time grouping to apply.","enum":["DATE_TIME_RULE_TYPE_UNSPECIFIED","SECOND","MINUTE","HOUR","HOUR_MINUTE","HOUR_MINUTE_AMPM","DAY_OF_WEEK","DAY_OF_YEAR","DAY_OF_MONTH","DAY_MONTH","MONTH","QUARTER","YEAR","YEAR_MONTH","YEAR_QUARTER","YEAR_MONTH_DAY"],"type":"string"}}},"sheets_v4_DeleteBandingRequest":{"description":"Removes the banded range with the given ID from the spreadsheet.","type":"object","properties":{"bandedRangeId":{"description":"The ID of the banded range to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteCommentReplyRequest":{"description":"Deletes a reply Post from a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains a comment action. - The reply post contains an assignee.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"postId":{"description":"The ID of the reply Post being deleted.","type":"string"}}},"sheets_v4_DeleteCommentRequest":{"description":"Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread that is being deleted.","type":"string"}}},"sheets_v4_DeleteConditionalFormatRuleRequest":{"description":"Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented.","type":"object","properties":{"index":{"description":"The zero-based index of the rule to be deleted.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet the rule is being deleted from.","format":"int32","type":"integer"}}},"sheets_v4_DeleteConditionalFormatRuleResponse":{"description":"The result of deleting a conditional format rule.","type":"object","properties":{"rule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}}},"sheets_v4_DeleteDataSourceRequest":{"description":"Deletes a data source. The request also deletes the associated data source sheet, and unlinks all associated data source objects.","type":"object","properties":{"dataSourceId":{"description":"The ID of the data source to delete.","type":"string"}}},"sheets_v4_DeleteDeveloperMetadataRequest":{"description":"A request to delete developer metadata.","type":"object","properties":{"dataFilter":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}}},"sheets_v4_DeleteDeveloperMetadataResponse":{"description":"The response from deleting developer metadata.","type":"object","properties":{"deletedDeveloperMetadata":{"description":"The metadata that was deleted.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}}},"sheets_v4_DeleteDimensionGroupRequest":{"description":"Deletes a group over the specified range by decrementing the depth of the dimensions in the range. For example, assume the sheet has a depth-1 group over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the sheet with a depth-1 group over B:D and a depth-2 group over C:C.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_DeleteDimensionGroupResponse":{"description":"The result of deleting a group.","type":"object","properties":{"dimensionGroups":{"description":"All groups of a dimension after deleting a group from that dimension.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}}}},"sheets_v4_DeleteDimensionRequest":{"description":" Deletes the dimensions from the sheet.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_DeleteDuplicatesRequest":{"description":"Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. Rows with identical values but different letter cases, formatting, or formulas are considered to be duplicates. This request also removes duplicate rows hidden from view (for example, due to a filter). When removing duplicates, the first instance of each duplicate row scanning from the top downwards is kept in the resulting range. Content outside of the specified range isn't removed, and rows considered duplicates do not have to be adjacent to each other in the range.","type":"object","properties":{"comparisonColumns":{"description":"The columns in the range to analyze for duplicate values. If no columns are selected then all columns are analyzed for duplicates.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_DeleteDuplicatesResponse":{"description":"The result of removing duplicates in a range.","type":"object","properties":{"duplicatesRemovedCount":{"description":"The number of duplicate rows removed.","format":"int32","type":"integer"}}},"sheets_v4_DeleteEmbeddedObjectRequest":{"description":"Deletes the embedded object with the given ID.","type":"object","properties":{"objectId":{"description":"The ID of the embedded object to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteFilterViewRequest":{"description":"Deletes a particular filter view.","type":"object","properties":{"filterId":{"description":"The ID of the filter to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteNamedRangeRequest":{"description":"Removes the named range with the given ID from the spreadsheet.","type":"object","properties":{"namedRangeId":{"description":"The ID of the named range to delete.","type":"string"}}},"sheets_v4_DeleteProtectedRangeRequest":{"description":"Deletes the protected range with the given ID.","type":"object","properties":{"protectedRangeId":{"description":"The ID of the protected range to delete.","format":"int32","type":"integer"}}},"sheets_v4_DeleteRangeRequest":{"description":"Deletes a range of cells, shifting other cells into the deleted area.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"shiftDimension":{"description":"The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"}}},"sheets_v4_DeleteSheetRequest":{"description":"Deletes the requested sheet.","type":"object","properties":{"sheetId":{"description":"The ID of the sheet to delete. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted.","format":"int32","type":"integer"}}},"sheets_v4_DeleteTableRequest":{"description":"Removes the table with the given ID from the spreadsheet.","type":"object","properties":{"tableId":{"description":"The ID of the table to delete.","type":"string"}}},"sheets_v4_DeveloperMetadata":{"description":"Developer metadata associated with a location or object in a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and it will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata is still associated with the row it was first associated with (what is now row 6). If the associated object is deleted then its metadata is deleted too.","type":"object","properties":{"location":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadataLocation"},"metadataId":{"description":"The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.","format":"int32","type":"integer"},"metadataKey":{"description":"The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.","type":"string"},"metadataValue":{"description":"Data associated with the metadata's key.","type":"string"},"visibility":{"description":"The metadata visibility. Developer metadata must always have visibility specified.","enum":["DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED","DOCUMENT","PROJECT"],"type":"string"}}},"sheets_v4_DeveloperMetadataLocation":{"description":"A location where metadata may be associated in a spreadsheet.","type":"object","properties":{"dimensionRange":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"},"locationType":{"description":"The type of location this object represents. This field is read-only.","enum":["DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED","ROW","COLUMN","SHEET","SPREADSHEET"],"type":"string"},"sheetId":{"description":"The ID of the sheet when metadata is associated with an entire sheet.","format":"int32","type":"integer"},"spreadsheet":{"description":"True when metadata is associated with an entire spreadsheet.","type":"boolean"}}},"sheets_v4_DeveloperMetadataLookup":{"description":"Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that match the intersection of all the specified fields; any field or combination of fields may be specified.","type":"object","properties":{"locationMatchingStrategy":{"description":"Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.","enum":["DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED","EXACT_LOCATION","INTERSECTING_LOCATION"],"type":"string"},"locationType":{"description":"Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location. Spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.","enum":["DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED","ROW","COLUMN","SHEET","SPREADSHEET"],"type":"string"},"metadataId":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.","format":"int32","type":"integer"},"metadataKey":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.","type":"string"},"metadataLocation":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadataLocation"},"metadataValue":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.","type":"string"},"visibility":{"description":"Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visible to the requesting project is considered.","enum":["DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED","DOCUMENT","PROJECT"],"type":"string"}}},"sheets_v4_DimensionGroup":{"description":"A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.","type":"object","properties":{"collapsed":{"description":"This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false.","type":"boolean"},"depth":{"description":"The depth of the group, representing how many groups have a range that wholly contains the range of this group.","format":"int32","type":"integer"},"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_DimensionProperties":{"description":"Properties about a dimension.","type":"object","properties":{"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"developerMetadata":{"description":"The developer metadata associated with a single row or column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}},"hiddenByFilter":{"description":"True if this dimension is being filtered. This field is read-only.","type":"boolean"},"hiddenByUser":{"description":"True if this dimension is explicitly hidden.","type":"boolean"},"pixelSize":{"description":"The height (if a row) or width (if a column) of the dimension in pixels.","format":"int32","type":"integer"}}},"sheets_v4_DimensionRange":{"description":"A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.","type":"object","properties":{"dimension":{"description":"The dimension of the span.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"endIndex":{"description":"The end (exclusive) of the span, or not set if unbounded.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet this span is on.","format":"int32","type":"integer"},"startIndex":{"description":"The start (inclusive) of the span, or not set if unbounded.","format":"int32","type":"integer"}}},"sheets_v4_DuplicateFilterViewRequest":{"description":"Duplicates a particular filter view.","type":"object","properties":{"filterId":{"description":"The ID of the filter being duplicated.","format":"int32","type":"integer"}}},"sheets_v4_DuplicateFilterViewResponse":{"description":"The result of a filter view being duplicated.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_DuplicateSheetRequest":{"description":"Duplicates the contents of a sheet.","type":"object","properties":{"insertSheetIndex":{"description":"The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented.","format":"int32","type":"integer"},"newSheetId":{"description":"If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative.","format":"int32","type":"integer"},"newSheetName":{"description":"The name of the new sheet. If empty, a new name is chosen for you.","type":"string"},"sourceSheetId":{"description":"The sheet to duplicate. If the source sheet is of DATA_SOURCE type, its backing DataSource is also duplicated and associated with the new copy of the sheet. No data execution is triggered, the grid data of this sheet is also copied over but only available after the batch request completes.","format":"int32","type":"integer"}}},"sheets_v4_DuplicateSheetResponse":{"description":"The result of duplicating a sheet.","type":"object","properties":{"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_Editors":{"description":"The editors of a protected range.","type":"object","properties":{"domainUsersCanEdit":{"description":"True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain.","type":"boolean"},"groups":{"description":"The email addresses of groups with edit access to the protected range.","type":"array","items":{"type":"string"}},"users":{"description":"The email addresses of users with edit access to the protected range.","type":"array","items":{"type":"string"}}}},"sheets_v4_EmbeddedChart":{"description":"A chart embedded in a sheet.","type":"object","properties":{"border":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectBorder"},"chartId":{"description":"The ID of the chart.","format":"int32","type":"integer"},"position":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"},"spec":{"$ref":"#/components/schemas/sheets_v4_ChartSpec"}}},"sheets_v4_EmbeddedObjectBorder":{"description":"A border along an embedded object.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_EmbeddedObjectPosition":{"description":"The position of an embedded object such as a chart.","type":"object","properties":{"newSheet":{"description":"If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.","type":"boolean"},"overlayPosition":{"$ref":"#/components/schemas/sheets_v4_OverlayPosition"},"sheetId":{"description":"The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.","format":"int32","type":"integer"}}},"sheets_v4_ErrorValue":{"description":"An error in a cell.","type":"object","properties":{"message":{"description":"A message with more information about the error (in the spreadsheet's locale).","type":"string"},"type":{"description":"The type of error.","enum":["ERROR_TYPE_UNSPECIFIED","ERROR","NULL_VALUE","DIVIDE_BY_ZERO","VALUE","REF","NAME","NUM","N_A","LOADING"],"type":"string"}}},"sheets_v4_ExtendedValue":{"description":"The kinds of value that a cell in a spreadsheet can have.","type":"object","properties":{"boolValue":{"description":"Represents a boolean value.","type":"boolean"},"errorValue":{"$ref":"#/components/schemas/sheets_v4_ErrorValue"},"formulaValue":{"description":"Represents a formula.","type":"string"},"numberValue":{"description":"Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in SERIAL_NUMBER format.","format":"double","type":"number"},"stringValue":{"description":"Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `\"123\"`.","type":"string"}}},"sheets_v4_FilterCriteria":{"description":"Criteria for showing or hiding rows in a filter or filter view.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"hiddenValues":{"description":"Values that should be hidden.","type":"array","items":{"type":"string"}},"visibleBackgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"visibleBackgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"visibleForegroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"visibleForegroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_FilterSpec":{"description":"The filter criteria associated with a specific column.","type":"object","properties":{"columnIndex":{"description":"The zero-based column index.","format":"int32","type":"integer"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"filterCriteria":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"}}},"sheets_v4_FilterView":{"description":"A filter view. For more information, see [Manage data visibility with filters](https://developers.google.com/workspace/sheets/api/guides/filters).","type":"object","properties":{"criteria":{"description":"The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column. This field is deprecated in favor of filter_specs.","type":"object","additionalProperties":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"}},"filterSpecs":{"description":"The filter criteria for showing or hiding values per column. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterSpec"}},"filterViewId":{"description":"The ID of the filter view.","format":"int32","type":"integer"},"namedRangeId":{"description":"The named range this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sortSpecs":{"description":"The sort order per column. Later specifications are used when values are equal in the earlier specifications.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}},"tableId":{"description":"The table this filter view is backed by, if any. When writing, only one of range, named_range_id, or table_id may be set.","type":"string"},"title":{"description":"The name of the filter view.","type":"string"}}},"sheets_v4_FindReplaceRequest":{"description":"Finds and replaces data in cells over a range, sheet, or all sheets.","type":"object","properties":{"allSheets":{"description":"True to find/replace over all sheets.","type":"boolean"},"find":{"description":"The value to search.","type":"string"},"includeFormulas":{"description":"True if the search should include cells with formulas. False to skip cells with formulas.","type":"boolean"},"matchCase":{"description":"True if the search is case sensitive.","type":"boolean"},"matchEntireCell":{"description":"True if the find value should match the entire cell.","type":"boolean"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"replacement":{"description":"The value to use as the replacement.","type":"string"},"searchByRegex":{"description":"True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents `\"Google Sheets\"` and another has `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of `\"$1 Rocks\"` would change the contents of the cells to `\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.","type":"boolean"},"sheetId":{"description":"The sheet to find/replace over.","format":"int32","type":"integer"}}},"sheets_v4_FindReplaceResponse":{"description":"The result of the find/replace.","type":"object","properties":{"formulasChanged":{"description":"The number of formula cells changed.","format":"int32","type":"integer"},"occurrencesChanged":{"description":"The number of occurrences (possibly multiple within a cell) changed. For example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would be `\"3\"` because `\"Google Sheets\"` -> `\"Googlo Shoots\"`.","format":"int32","type":"integer"},"rowsChanged":{"description":"The number of rows changed.","format":"int32","type":"integer"},"sheetsChanged":{"description":"The number of sheets changed.","format":"int32","type":"integer"},"valuesChanged":{"description":"The number of non-formula cells changed.","format":"int32","type":"integer"}}},"sheets_v4_GetSpreadsheetByDataFilterRequest":{"description":"The request for retrieving a Spreadsheet.","type":"object","properties":{"commentsViewMode":{"description":"The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"dataFilters":{"description":"The DataFilters used to select which ranges to retrieve from the spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"excludeTablesInBandedRanges":{"description":"True if tables should be excluded in the banded ranges. False if not set.","type":"boolean"},"includeGridData":{"description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request.","type":"boolean"}}},"sheets_v4_GradientRule":{"description":"A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.","type":"object","properties":{"maxpoint":{"$ref":"#/components/schemas/sheets_v4_InterpolationPoint"},"midpoint":{"$ref":"#/components/schemas/sheets_v4_InterpolationPoint"},"minpoint":{"$ref":"#/components/schemas/sheets_v4_InterpolationPoint"}}},"sheets_v4_GridCoordinate":{"description":"A coordinate in a sheet. All indexes are zero-based.","type":"object","properties":{"columnIndex":{"description":"The column index of the coordinate.","format":"int32","type":"integer"},"rowIndex":{"description":"The row index of the coordinate.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet this coordinate is on.","format":"int32","type":"integer"}}},"sheets_v4_GridData":{"description":"Data in the grid, as well as metadata about the dimensions.","type":"object","properties":{"columnMetadata":{"description":"Metadata about the requested columns in the grid, starting with the column in start_column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionProperties"}},"rowData":{"description":"The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RowData"}},"rowMetadata":{"description":"Metadata about the requested rows in the grid, starting with the row in start_row.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionProperties"}},"startColumn":{"description":"The first column this GridData refers to, zero-based.","format":"int32","type":"integer"},"startRow":{"description":"The first row this GridData refers to, zero-based.","format":"int32","type":"integer"}}},"sheets_v4_GridProperties":{"description":"Properties of a grid.","type":"object","properties":{"columnCount":{"description":"The number of columns in the grid.","format":"int32","type":"integer"},"columnGroupControlAfter":{"description":"True if the column grouping control toggle is shown after the group.","type":"boolean"},"frozenColumnCount":{"description":"The number of columns that are frozen in the grid.","format":"int32","type":"integer"},"frozenRowCount":{"description":"The number of rows that are frozen in the grid.","format":"int32","type":"integer"},"hideGridlines":{"description":"True if the grid isn't showing gridlines in the UI.","type":"boolean"},"rowCount":{"description":"The number of rows in the grid.","format":"int32","type":"integer"},"rowGroupControlAfter":{"description":"True if the row grouping control toggle is shown after the group.","type":"boolean"}}},"sheets_v4_GridRange":{"description":"A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `\"Sheet1\"` is sheet ID 123456, then: `Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id: 123456` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.","type":"object","properties":{"endColumnIndex":{"description":"The end column (exclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"},"endRowIndex":{"description":"The end row (exclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"},"sheetId":{"description":"The sheet this range is on.","format":"int32","type":"integer"},"startColumnIndex":{"description":"The start column (inclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"},"startRowIndex":{"description":"The start row (inclusive) of the range, or not set if unbounded.","format":"int32","type":"integer"}}},"sheets_v4_HistogramChartSpec":{"description":"A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.","type":"object","properties":{"bucketSize":{"description":"By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.","format":"double","type":"number"},"legendPosition":{"description":"The position of the chart legend.","enum":["HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND","INSIDE_LEGEND"],"type":"string"},"outlierPercentile":{"description":"The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5.","format":"double","type":"number"},"series":{"description":"The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_HistogramSeries"}},"showItemDividers":{"description":"Whether horizontal divider lines should be displayed between items in each column.","type":"boolean"}}},"sheets_v4_HistogramRule":{"description":"Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+","type":"object","properties":{"end":{"description":"The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.","format":"double","type":"number"},"interval":{"description":"The size of the buckets that are created. Must be positive.","format":"double","type":"number"},"start":{"description":"The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.","format":"double","type":"number"}}},"sheets_v4_HistogramSeries":{"description":"A histogram series containing the series color and data.","type":"object","properties":{"barColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"barColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_InsertCommentRequest":{"description":"Inserts a CommentThread into the spreadsheet.","type":"object","properties":{"assigneeEmailAddress":{"description":"Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units.","type":"string"},"content":{"description":"The text of the comment, as plain text. This text content will be handled similarly to comments created in the Sheets editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"coordinate":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"}}},"sheets_v4_InsertCommentResponse":{"description":"The result of creating a comment.","type":"object","properties":{"commentThread":{"$ref":"#/components/schemas/sheets_v4_CommentThread"}}},"sheets_v4_InsertDimensionRequest":{"description":"Inserts rows or columns in a sheet at a particular index.","type":"object","properties":{"inheritFromBefore":{"description":"Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green).","type":"boolean"},"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_InsertRangeRequest":{"description":"Inserts cells into a range, shifting the existing cells over or down.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"shiftDimension":{"description":"The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"}}},"sheets_v4_InterpolationPoint":{"description":"A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"type":{"description":"How the value should be interpreted.","enum":["INTERPOLATION_POINT_TYPE_UNSPECIFIED","MIN","MAX","NUMBER","PERCENT","PERCENTILE"],"type":"string"},"value":{"description":"The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.","type":"string"}}},"sheets_v4_Interval":{"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.","type":"object","properties":{"endTime":{"description":"Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.","format":"google-datetime","type":"string"},"startTime":{"description":"Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.","format":"google-datetime","type":"string"}}},"sheets_v4_IterativeCalculationSettings":{"description":"Settings to control how circular dependencies are resolved with iterative calculation.","type":"object","properties":{"convergenceThreshold":{"description":"When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.","format":"double","type":"number"},"maxIterations":{"description":"When iterative calculation is enabled, the maximum number of calculation rounds to perform.","format":"int32","type":"integer"}}},"sheets_v4_KeyValueFormat":{"description":"Formatting options for key value.","type":"object","properties":{"position":{"$ref":"#/components/schemas/sheets_v4_TextPosition"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"}}},"sheets_v4_LineStyle":{"description":"Properties that describe the style of a line.","type":"object","properties":{"type":{"description":"The dash type of the line.","enum":["LINE_DASH_TYPE_UNSPECIFIED","INVISIBLE","CUSTOM","SOLID","DOTTED","MEDIUM_DASHED","MEDIUM_DASHED_DOTTED","LONG_DASHED","LONG_DASHED_DOTTED"],"type":"string"},"width":{"description":"The thickness of the line, in px.","format":"int32","type":"integer"}}},"sheets_v4_Link":{"description":"An external or local reference.","type":"object","properties":{"uri":{"description":"The link identifier.","type":"string"}}},"sheets_v4_LookerDataSourceSpec":{"description":"The specification of a Looker data source.","type":"object","properties":{"explore":{"description":"Name of a Looker model explore.","type":"string"},"instanceUri":{"description":"A Looker instance URL.","type":"string"},"model":{"description":"Name of a Looker model.","type":"string"}}},"sheets_v4_ManualRule":{"description":"Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+","type":"object","properties":{"groups":{"description":"The list of group names and the corresponding items from the source data that map to each group name.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ManualRuleGroup"}}}},"sheets_v4_ManualRuleGroup":{"description":"A group name and a list of items from the source data that should be placed in the group with this name.","type":"object","properties":{"groupName":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"},"items":{"description":"The items in the source data that should be placed into this group. Each item may be a string, number, or boolean. Items may appear in at most one group within a given ManualRule. Items that do not appear in any group will appear on their own.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}}}},"sheets_v4_MatchedDeveloperMetadata":{"description":"A developer metadata entry and the data filters specified in the original request that matched it.","type":"object","properties":{"dataFilters":{"description":"All filters matching the returned developer metadata.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}},"sheets_v4_MatchedValueRange":{"description":"A value range that was matched by one or more data filers.","type":"object","properties":{"dataFilters":{"description":"The DataFilters from the request that matched the range of values.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"valueRange":{"$ref":"#/components/schemas/sheets_v4_ValueRange"}}},"sheets_v4_MergeCellsRequest":{"description":"Merges all cells in the range.","type":"object","properties":{"mergeType":{"description":"How the cells should be merged.","enum":["MERGE_ALL","MERGE_COLUMNS","MERGE_ROWS"],"type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_MoveDimensionRequest":{"description":"Moves one or more rows or columns.","type":"object","properties":{"destinationIndex":{"description":"The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move `\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be `ROWS [1..3)`,and the destination index would be `\"4\"` (the zero-based index of row 5). The end result would be `A1..A5` of `0, 3, 1, 2, 4`.","format":"int32","type":"integer"},"source":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_NamedRange":{"description":"A named range.","type":"object","properties":{"name":{"description":"The name of the named range.","type":"string"},"namedRangeId":{"description":"The ID of the named range.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_NumberFormat":{"description":"The number format of a cell.","type":"object","properties":{"pattern":{"description":"Pattern string used for formatting. If not set, a default pattern based on the spreadsheet's locale will be used if necessary for the given type. See the [Date and Number Formats guide](https://developers.google.com/workspace/sheets/api/guides/formats) for more information about the supported patterns.","type":"string"},"type":{"description":"The type of the number format. When writing, this field must be set.","enum":["NUMBER_FORMAT_TYPE_UNSPECIFIED","TEXT","NUMBER","PERCENT","CURRENCY","DATE","TIME","DATE_TIME","SCIENTIFIC"],"type":"string"}}},"sheets_v4_OrgChartSpec":{"description":"An org chart. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain \"Alice\", \"Bob\", \"Cathy\", parent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain \"CEO\", \"President\", \"VP Sales\".","type":"object","properties":{"labels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"nodeColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"nodeColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"nodeSize":{"description":"The size of the org chart nodes.","enum":["ORG_CHART_LABEL_SIZE_UNSPECIFIED","SMALL","MEDIUM","LARGE"],"type":"string"},"parentLabels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"selectedNodeColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"selectedNodeColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"tooltips":{"$ref":"#/components/schemas/sheets_v4_ChartData"}}},"sheets_v4_OverlayPosition":{"description":"The location an object is overlaid on top of a grid.","type":"object","properties":{"anchorCell":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"heightPixels":{"description":"The height of the object, in pixels. Defaults to 371.","format":"int32","type":"integer"},"offsetXPixels":{"description":"The horizontal offset, in pixels, that the object is offset from the anchor cell.","format":"int32","type":"integer"},"offsetYPixels":{"description":"The vertical offset, in pixels, that the object is offset from the anchor cell.","format":"int32","type":"integer"},"widthPixels":{"description":"The width of the object, in pixels. Defaults to 600.","format":"int32","type":"integer"}}},"sheets_v4_Padding":{"description":"The amount of padding around the cell, in pixels. When updating padding, every field must be specified.","type":"object","properties":{"bottom":{"description":"The bottom padding of the cell.","format":"int32","type":"integer"},"left":{"description":"The left padding of the cell.","format":"int32","type":"integer"},"right":{"description":"The right padding of the cell.","format":"int32","type":"integer"},"top":{"description":"The top padding of the cell.","format":"int32","type":"integer"}}},"sheets_v4_PasteDataRequest":{"description":"Inserts data into the spreadsheet starting at the specified coordinate.","type":"object","properties":{"coordinate":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"},"data":{"description":"The data to insert.","type":"string"},"delimiter":{"description":"The delimiter in the data.","type":"string"},"html":{"description":"True if the data is HTML.","type":"boolean"},"type":{"description":"How the data should be pasted.","enum":["PASTE_NORMAL","PASTE_VALUES","PASTE_FORMAT","PASTE_NO_BORDERS","PASTE_FORMULA","PASTE_DATA_VALIDATION","PASTE_CONDITIONAL_FORMATTING"],"type":"string"}}},"sheets_v4_PersonProperties":{"description":"Properties specific to a linked person.","type":"object","properties":{"displayFormat":{"description":"Optional. The display format of the person chip. If not set, the default display format is used.","enum":["DISPLAY_FORMAT_UNSPECIFIED","DEFAULT","LAST_NAME_COMMA_FIRST_NAME","EMAIL"],"type":"string"},"email":{"description":"Required. The email address linked to this person. This field is always present.","type":"string"}}},"sheets_v4_PieChartSpec":{"description":"A pie chart.","type":"object","properties":{"domain":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"legendPosition":{"description":"Where the legend of the pie chart should be drawn.","enum":["PIE_CHART_LEGEND_POSITION_UNSPECIFIED","BOTTOM_LEGEND","LEFT_LEGEND","RIGHT_LEGEND","TOP_LEGEND","NO_LEGEND","LABELED_LEGEND"],"type":"string"},"pieHole":{"description":"The size of the hole in the pie chart.","format":"double","type":"number"},"series":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"threeDimensional":{"description":"True if the pie is three dimensional.","type":"boolean"}}},"sheets_v4_PivotFilterCriteria":{"description":"Criteria for showing/hiding rows in a pivot table.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"},"visibleByDefault":{"description":"Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.","type":"boolean"},"visibleValues":{"description":"Values that should be included. Values not listed here are excluded.","type":"array","items":{"type":"string"}}}},"sheets_v4_PivotFilterSpec":{"description":"The pivot table filter criteria associated with a specific source column offset.","type":"object","properties":{"columnOffsetIndex":{"description":"The zero-based column offset of the source range.","format":"int32","type":"integer"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"filterCriteria":{"$ref":"#/components/schemas/sheets_v4_PivotFilterCriteria"}}},"sheets_v4_PivotGroup":{"description":"A single grouping (either row or column) in a pivot table.","type":"object","properties":{"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"groupLimit":{"$ref":"#/components/schemas/sheets_v4_PivotGroupLimit"},"groupRule":{"$ref":"#/components/schemas/sheets_v4_PivotGroupRule"},"label":{"description":"The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables created before December 2017 do not have header labels. If you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then create a new pivot table with same parameters. +--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+","type":"string"},"repeatHeadings":{"description":"True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repetition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to \"Q1 Mar\", \"Q1\" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause \"Q1\" to be repeated for \"Feb\" and \"Mar\". +--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+","type":"boolean"},"showTotals":{"description":"True if the pivot table should include the totals for this grouping.","type":"boolean"},"sortOrder":{"description":"The order the values in this group should be sorted.","enum":["SORT_ORDER_UNSPECIFIED","ASCENDING","DESCENDING"],"type":"string"},"sourceColumnOffset":{"description":"The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.","format":"int32","type":"integer"},"valueBucket":{"$ref":"#/components/schemas/sheets_v4_PivotGroupSortValueBucket"},"valueMetadata":{"description":"Metadata about values in the grouping.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotGroupValueMetadata"}}}},"sheets_v4_PivotGroupLimit":{"description":"The count limit on rows or columns in the pivot group.","type":"object","properties":{"applyOrder":{"description":"The order in which the group limit is applied to the pivot table. Pivot group limits are applied from lower to higher order number. Order numbers are normalized to consecutive integers from 0. For write request, to fully customize the applying orders, all pivot group limits should have this field set with an unique number. Otherwise, the order is determined by the index in the PivotTable.rows list and then the PivotTable.columns list.","format":"int32","type":"integer"},"countLimit":{"description":"The count limit.","format":"int32","type":"integer"}}},"sheets_v4_PivotGroupRule":{"description":"An optional setting on a PivotGroup that defines buckets for the values in the source data column rather than breaking out each individual value. Only one PivotGroup with a group rule may be added for each column in the source data, though on any given column you may add both a PivotGroup that has a rule and a PivotGroup that does not.","type":"object","properties":{"dateTimeRule":{"$ref":"#/components/schemas/sheets_v4_DateTimeRule"},"histogramRule":{"$ref":"#/components/schemas/sheets_v4_HistogramRule"},"manualRule":{"$ref":"#/components/schemas/sheets_v4_ManualRule"}}},"sheets_v4_PivotGroupSortValueBucket":{"description":"Information about which values in a pivot group should be used for sorting.","type":"object","properties":{"buckets":{"description":"Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the \"Grand Total\" over the column groups. If a single value is listed, this would correspond to using the \"Total\" of that bucket.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}},"valuesIndex":{"description":"The offset in the PivotTable.values list which the values in this grouping should be sorted by.","format":"int32","type":"integer"}}},"sheets_v4_PivotGroupValueMetadata":{"description":"Metadata about a value in a pivot grouping.","type":"object","properties":{"collapsed":{"description":"True if the data corresponding to the value is collapsed.","type":"boolean"},"value":{"$ref":"#/components/schemas/sheets_v4_ExtendedValue"}}},"sheets_v4_PivotTable":{"description":"A pivot table.","type":"object","properties":{"columns":{"description":"Each column grouping in the pivot table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotGroup"}},"criteria":{"description":"An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. This field is deprecated in favor of filter_specs.","type":"object","additionalProperties":{"$ref":"#/components/schemas/sheets_v4_PivotFilterCriteria"}},"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSourceId":{"description":"The ID of the data source the pivot table is reading data from.","type":"string"},"filterSpecs":{"description":"The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotFilterSpec"}},"rows":{"description":"Each row grouping in the pivot table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotGroup"}},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"valueLayout":{"description":"Whether values should be listed horizontally (as columns) or vertically (as rows).","enum":["HORIZONTAL","VERTICAL"],"type":"string"},"values":{"description":"A list of values to include in the pivot table.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_PivotValue"}}}},"sheets_v4_PivotValue":{"description":"The definition of how a value in a pivot table should be calculated.","type":"object","properties":{"calculatedDisplayType":{"description":"If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets editor, this is referred to as \"Show As\" in the value section of a pivot table.","enum":["PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED","PERCENT_OF_ROW_TOTAL","PERCENT_OF_COLUMN_TOTAL","PERCENT_OF_GRAND_TOTAL"],"type":"string"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"formula":{"description":"A custom formula to calculate the value. The formula must start with an `=` character.","type":"string"},"name":{"description":"A name to use for the value.","type":"string"},"sourceColumnOffset":{"description":"The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.","format":"int32","type":"integer"},"summarizeFunction":{"description":"A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.","enum":["PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED","SUM","COUNTA","COUNT","COUNTUNIQUE","AVERAGE","MAX","MIN","MEDIAN","PRODUCT","STDEV","STDEVP","VAR","VARP","CUSTOM","NONE"],"type":"string"}}},"sheets_v4_PointStyle":{"description":"The style of a point on the chart.","type":"object","properties":{"shape":{"description":"The point shape. If empty or unspecified, a default shape is used.","enum":["POINT_SHAPE_UNSPECIFIED","CIRCLE","DIAMOND","HEXAGON","PENTAGON","SQUARE","STAR","TRIANGLE","X_MARK"],"type":"string"},"size":{"description":"The point size. If empty, a default size is used.","format":"double","type":"number"}}},"sheets_v4_Post":{"description":"Represents a single post in a comment thread.","type":"object","properties":{"assigneeEmail":{"description":"Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assignee_email` exceeds 2048 UTF-8 code units.","type":"string"},"author":{"$ref":"#/components/schemas/sheets_v4_PostAuthor"},"commentAction":{"description":"Action taken as part of creating the post.","enum":["COMMENT_ACTION_TYPE_UNSPECIFIED","NO_COMMENT_ACTION_CHANGE","RESOLVE","REOPEN"],"type":"string"},"content":{"description":"The content of the post. Required to be non-empty if comment_action is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Sheets editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.","type":"string"},"contentHtml":{"description":"Output only. The content of the post as HTML.","type":"string"},"createTime":{"description":"Output only. The time the post was created.","format":"google-datetime","type":"string"},"deleted":{"description":"Output only. Whether the post is deleted. If `true`, content and author fields will be empty.","type":"boolean"},"fromCopiedSpreadsheet":{"description":"Output only. Whether the post is from a copied spreadsheet. This field cannot be set directly by callers.","type":"boolean"},"fromImportedSpreadsheet":{"description":"Output only. Whether the post is from an imported spreadsheet. This field cannot be set directly by callers.","type":"boolean"},"postId":{"description":"Output only. The unique ID of the post.","type":"string"},"updateTime":{"description":"Output only. The time the post was last updated.","format":"google-datetime","type":"string"}}},"sheets_v4_PostAuthor":{"description":"Represents a user who authored a comment post.","type":"object","properties":{"anonymous":{"description":"Whether the user is anonymous.","type":"boolean"},"displayName":{"description":"The display name of the user. May be absent if the author is anonymous.","type":"string"},"me":{"description":"Whether the user is the authenticated user making the request.","type":"boolean"},"user":{"description":"The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported spreadsheet.","type":"string"}}},"sheets_v4_ProtectedRange":{"description":"A protected range.","type":"object","properties":{"description":{"description":"The description of this protected range.","type":"string"},"editors":{"$ref":"#/components/schemas/sheets_v4_Editors"},"namedRangeId":{"description":"The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.","type":"string"},"protectedRangeId":{"description":"The ID of the protected range. This field is read-only.","format":"int32","type":"integer"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"requestingUserCanEdit":{"description":"True if the user who requested this protected range can edit the protected area. This field is read-only.","type":"boolean"},"tableId":{"description":"The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set.","type":"string"},"unprotectedRanges":{"description":"The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}},"warningOnly":{"description":"True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors are ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document.","type":"boolean"}}},"sheets_v4_RandomizeRangeRequest":{"description":"Randomizes the order of the rows in a range.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_RefreshCancellationStatus":{"description":"The status of a refresh cancellation. You can send a cancel request to explicitly cancel one or multiple data source object refreshes.","type":"object","properties":{"errorCode":{"description":"The error code.","enum":["REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED","EXECUTION_NOT_FOUND","CANCEL_PERMISSION_DENIED","QUERY_EXECUTION_COMPLETED","CONCURRENT_CANCELLATION","CANCEL_OTHER_ERROR"],"type":"string"},"state":{"description":"The state of a call to cancel a refresh in Sheets.","enum":["REFRESH_CANCELLATION_STATE_UNSPECIFIED","CANCEL_SUCCEEDED","CANCEL_FAILED"],"type":"string"}}},"sheets_v4_RefreshDataSourceObjectExecutionStatus":{"description":"The execution status of refreshing one data source object.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"reference":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReference"}}},"sheets_v4_RefreshDataSourceRequest":{"description":"Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.","type":"object","properties":{"dataSourceId":{"description":"Reference to a DataSource. If specified, refreshes all associated data source objects for the data source.","type":"string"},"force":{"description":"Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately.","type":"boolean"},"isAll":{"description":"Refreshes all existing data source objects in the spreadsheet.","type":"boolean"},"references":{"$ref":"#/components/schemas/sheets_v4_DataSourceObjectReferences"}}},"sheets_v4_RefreshDataSourceResponse":{"description":"The response from refreshing one or multiple data source objects.","type":"object","properties":{"statuses":{"description":"All the refresh status for the data source object references specified in the request. If is_all is specified, the field contains only those in failure status.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RefreshDataSourceObjectExecutionStatus"}}}},"sheets_v4_RepeatCellRequest":{"description":"Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the formula's ranges static, use the `$` indicator. For example, use the formula `=$A$1` to prevent both the row and the column from incrementing.","type":"object","properties":{"cell":{"$ref":"#/components/schemas/sheets_v4_CellData"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `cell` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_Request":{"description":"A single kind of update to apply to a spreadsheet.","type":"object","properties":{"addBanding":{"$ref":"#/components/schemas/sheets_v4_AddBandingRequest"},"addChart":{"$ref":"#/components/schemas/sheets_v4_AddChartRequest"},"addCommentReply":{"$ref":"#/components/schemas/sheets_v4_AddCommentReplyRequest"},"addConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_AddConditionalFormatRuleRequest"},"addDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_AddDimensionGroupRequest"},"addFilterView":{"$ref":"#/components/schemas/sheets_v4_AddFilterViewRequest"},"addNamedRange":{"$ref":"#/components/schemas/sheets_v4_AddNamedRangeRequest"},"addProtectedRange":{"$ref":"#/components/schemas/sheets_v4_AddProtectedRangeRequest"},"addSheet":{"$ref":"#/components/schemas/sheets_v4_AddSheetRequest"},"addSlicer":{"$ref":"#/components/schemas/sheets_v4_AddSlicerRequest"},"addTable":{"$ref":"#/components/schemas/sheets_v4_AddTableRequest"},"appendCells":{"$ref":"#/components/schemas/sheets_v4_AppendCellsRequest"},"appendDimension":{"$ref":"#/components/schemas/sheets_v4_AppendDimensionRequest"},"autoFill":{"$ref":"#/components/schemas/sheets_v4_AutoFillRequest"},"autoResizeDimensions":{"$ref":"#/components/schemas/sheets_v4_AutoResizeDimensionsRequest"},"clearBasicFilter":{"$ref":"#/components/schemas/sheets_v4_ClearBasicFilterRequest"},"copyPaste":{"$ref":"#/components/schemas/sheets_v4_CopyPasteRequest"},"createDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_CreateDeveloperMetadataRequest"},"cutPaste":{"$ref":"#/components/schemas/sheets_v4_CutPasteRequest"},"deleteBanding":{"$ref":"#/components/schemas/sheets_v4_DeleteBandingRequest"},"deleteComment":{"$ref":"#/components/schemas/sheets_v4_DeleteCommentRequest"},"deleteCommentReply":{"$ref":"#/components/schemas/sheets_v4_DeleteCommentReplyRequest"},"deleteConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_DeleteConditionalFormatRuleRequest"},"deleteDataSource":{"$ref":"#/components/schemas/sheets_v4_DeleteDataSourceRequest"},"deleteDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_DeleteDeveloperMetadataRequest"},"deleteDimension":{"$ref":"#/components/schemas/sheets_v4_DeleteDimensionRequest"},"deleteDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_DeleteDimensionGroupRequest"},"deleteDuplicates":{"$ref":"#/components/schemas/sheets_v4_DeleteDuplicatesRequest"},"deleteEmbeddedObject":{"$ref":"#/components/schemas/sheets_v4_DeleteEmbeddedObjectRequest"},"deleteFilterView":{"$ref":"#/components/schemas/sheets_v4_DeleteFilterViewRequest"},"deleteNamedRange":{"$ref":"#/components/schemas/sheets_v4_DeleteNamedRangeRequest"},"deleteProtectedRange":{"$ref":"#/components/schemas/sheets_v4_DeleteProtectedRangeRequest"},"deleteRange":{"$ref":"#/components/schemas/sheets_v4_DeleteRangeRequest"},"deleteSheet":{"$ref":"#/components/schemas/sheets_v4_DeleteSheetRequest"},"deleteTable":{"$ref":"#/components/schemas/sheets_v4_DeleteTableRequest"},"duplicateFilterView":{"$ref":"#/components/schemas/sheets_v4_DuplicateFilterViewRequest"},"duplicateSheet":{"$ref":"#/components/schemas/sheets_v4_DuplicateSheetRequest"},"findReplace":{"$ref":"#/components/schemas/sheets_v4_FindReplaceRequest"},"insertComment":{"$ref":"#/components/schemas/sheets_v4_InsertCommentRequest"},"insertDimension":{"$ref":"#/components/schemas/sheets_v4_InsertDimensionRequest"},"insertRange":{"$ref":"#/components/schemas/sheets_v4_InsertRangeRequest"},"mergeCells":{"$ref":"#/components/schemas/sheets_v4_MergeCellsRequest"},"moveDimension":{"$ref":"#/components/schemas/sheets_v4_MoveDimensionRequest"},"pasteData":{"$ref":"#/components/schemas/sheets_v4_PasteDataRequest"},"randomizeRange":{"$ref":"#/components/schemas/sheets_v4_RandomizeRangeRequest"},"repeatCell":{"$ref":"#/components/schemas/sheets_v4_RepeatCellRequest"},"setBasicFilter":{"$ref":"#/components/schemas/sheets_v4_SetBasicFilterRequest"},"setDataValidation":{"$ref":"#/components/schemas/sheets_v4_SetDataValidationRequest"},"sortRange":{"$ref":"#/components/schemas/sheets_v4_SortRangeRequest"},"textToColumns":{"$ref":"#/components/schemas/sheets_v4_TextToColumnsRequest"},"trimWhitespace":{"$ref":"#/components/schemas/sheets_v4_TrimWhitespaceRequest"},"unmergeCells":{"$ref":"#/components/schemas/sheets_v4_UnmergeCellsRequest"},"updateBanding":{"$ref":"#/components/schemas/sheets_v4_UpdateBandingRequest"},"updateBorders":{"$ref":"#/components/schemas/sheets_v4_UpdateBordersRequest"},"updateCells":{"$ref":"#/components/schemas/sheets_v4_UpdateCellsRequest"},"updateChartSpec":{"$ref":"#/components/schemas/sheets_v4_UpdateChartSpecRequest"},"updateCommentPost":{"$ref":"#/components/schemas/sheets_v4_UpdateCommentPostRequest"},"updateConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_UpdateConditionalFormatRuleRequest"},"updateDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_UpdateDeveloperMetadataRequest"},"updateDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_UpdateDimensionGroupRequest"},"updateDimensionProperties":{"$ref":"#/components/schemas/sheets_v4_UpdateDimensionPropertiesRequest"},"updateEmbeddedObjectBorder":{"$ref":"#/components/schemas/sheets_v4_UpdateEmbeddedObjectBorderRequest"},"updateEmbeddedObjectPosition":{"$ref":"#/components/schemas/sheets_v4_UpdateEmbeddedObjectPositionRequest"},"updateFilterView":{"$ref":"#/components/schemas/sheets_v4_UpdateFilterViewRequest"},"updateNamedRange":{"$ref":"#/components/schemas/sheets_v4_UpdateNamedRangeRequest"},"updateProtectedRange":{"$ref":"#/components/schemas/sheets_v4_UpdateProtectedRangeRequest"},"updateSheetProperties":{"$ref":"#/components/schemas/sheets_v4_UpdateSheetPropertiesRequest"},"updateSlicerSpec":{"$ref":"#/components/schemas/sheets_v4_UpdateSlicerSpecRequest"},"updateSpreadsheetProperties":{"$ref":"#/components/schemas/sheets_v4_UpdateSpreadsheetPropertiesRequest"},"updateTable":{"$ref":"#/components/schemas/sheets_v4_UpdateTableRequest"}}},"sheets_v4_Response":{"description":"A single response from an update.","type":"object","properties":{"addBanding":{"$ref":"#/components/schemas/sheets_v4_AddBandingResponse"},"addChart":{"$ref":"#/components/schemas/sheets_v4_AddChartResponse"},"addCommentReply":{"$ref":"#/components/schemas/sheets_v4_AddCommentReplyResponse"},"addDataSource":{"$ref":"#/components/schemas/sheets_v4_AddDataSourceResponse"},"addDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_AddDimensionGroupResponse"},"addFilterView":{"$ref":"#/components/schemas/sheets_v4_AddFilterViewResponse"},"addNamedRange":{"$ref":"#/components/schemas/sheets_v4_AddNamedRangeResponse"},"addProtectedRange":{"$ref":"#/components/schemas/sheets_v4_AddProtectedRangeResponse"},"addSheet":{"$ref":"#/components/schemas/sheets_v4_AddSheetResponse"},"addSlicer":{"$ref":"#/components/schemas/sheets_v4_AddSlicerResponse"},"addTable":{"$ref":"#/components/schemas/sheets_v4_AddTableResponse"},"cancelDataSourceRefresh":{"$ref":"#/components/schemas/sheets_v4_CancelDataSourceRefreshResponse"},"createDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_CreateDeveloperMetadataResponse"},"deleteConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_DeleteConditionalFormatRuleResponse"},"deleteDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_DeleteDeveloperMetadataResponse"},"deleteDimensionGroup":{"$ref":"#/components/schemas/sheets_v4_DeleteDimensionGroupResponse"},"deleteDuplicates":{"$ref":"#/components/schemas/sheets_v4_DeleteDuplicatesResponse"},"duplicateFilterView":{"$ref":"#/components/schemas/sheets_v4_DuplicateFilterViewResponse"},"duplicateSheet":{"$ref":"#/components/schemas/sheets_v4_DuplicateSheetResponse"},"findReplace":{"$ref":"#/components/schemas/sheets_v4_FindReplaceResponse"},"insertComment":{"$ref":"#/components/schemas/sheets_v4_InsertCommentResponse"},"refreshDataSource":{"$ref":"#/components/schemas/sheets_v4_RefreshDataSourceResponse"},"trimWhitespace":{"$ref":"#/components/schemas/sheets_v4_TrimWhitespaceResponse"},"updateConditionalFormatRule":{"$ref":"#/components/schemas/sheets_v4_UpdateConditionalFormatRuleResponse"},"updateDataSource":{"$ref":"#/components/schemas/sheets_v4_UpdateDataSourceResponse"},"updateDeveloperMetadata":{"$ref":"#/components/schemas/sheets_v4_UpdateDeveloperMetadataResponse"},"updateEmbeddedObjectPosition":{"$ref":"#/components/schemas/sheets_v4_UpdateEmbeddedObjectPositionResponse"}}},"sheets_v4_RichLinkProperties":{"description":"Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes.","type":"object","properties":{"mimeType":{"description":"Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive).","readOnly":true,"type":"string"},"uri":{"description":"Required. The URI to the link. This is always present.","type":"string"}}},"sheets_v4_RowData":{"description":"Data about each cell in a row.","type":"object","properties":{"values":{"description":"The values in the row, one per column.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CellData"}}}},"sheets_v4_ScorecardChartSpec":{"description":"A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time.","type":"object","properties":{"aggregateType":{"description":"The aggregation type for key and baseline chart data in scorecard chart. This field is not supported for data source charts. Use the ChartData.aggregateType field of the key_value_data or baseline_value_data instead for data source charts. This field is optional.","enum":["CHART_AGGREGATE_TYPE_UNSPECIFIED","AVERAGE","COUNT","MAX","MEDIAN","MIN","SUM"],"type":"string"},"baselineValueData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"baselineValueFormat":{"$ref":"#/components/schemas/sheets_v4_BaselineValueFormat"},"customFormatOptions":{"$ref":"#/components/schemas/sheets_v4_ChartCustomNumberFormatOptions"},"keyValueData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"keyValueFormat":{"$ref":"#/components/schemas/sheets_v4_KeyValueFormat"},"numberFormatSource":{"description":"The number format source used in the scorecard chart. This field is optional.","enum":["CHART_NUMBER_FORMAT_SOURCE_UNDEFINED","FROM_DATA","CUSTOM"],"type":"string"},"scaleFactor":{"description":"Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.","format":"double","type":"number"}}},"sheets_v4_SearchDeveloperMetadataRequest":{"description":"A request to retrieve all developer metadata matching the set of specified criteria.","type":"object","properties":{"dataFilters":{"description":"The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}}}},"sheets_v4_SearchDeveloperMetadataResponse":{"description":"A reply to a developer metadata search request.","type":"object","properties":{"matchedDeveloperMetadata":{"description":"The metadata matching the criteria of the search request.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_MatchedDeveloperMetadata"}}}},"sheets_v4_SetBasicFilterRequest":{"description":"Sets the basic filter associated with a sheet.","type":"object","properties":{"filter":{"$ref":"#/components/schemas/sheets_v4_BasicFilter"}}},"sheets_v4_SetDataValidationRequest":{"description":"Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.","type":"object","properties":{"filteredRowsIncluded":{"description":"Optional. If true, the data validation rule will be applied to the filtered rows as well.","type":"boolean"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rule":{"$ref":"#/components/schemas/sheets_v4_DataValidationRule"}}},"sheets_v4_Sheet":{"description":"A sheet in a spreadsheet.","type":"object","properties":{"bandedRanges":{"description":"The banded (alternating colors) ranges on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_BandedRange"}},"basicFilter":{"$ref":"#/components/schemas/sheets_v4_BasicFilter"},"charts":{"description":"The specifications of every chart on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_EmbeddedChart"}},"columnGroups":{"description":"All column groups on this sheet, ordered by increasing range start index, then by group depth.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}},"commentAnchors":{"description":"The comment anchors on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CommentAnchor"}},"conditionalFormats":{"description":"The conditional format rules in this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}},"data":{"description":"Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D). For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridData"}},"developerMetadata":{"description":"The developer metadata associated with a sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}},"filterViews":{"description":"The filter views in this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_FilterView"}},"merges":{"description":"The ranges that are merged together.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_GridRange"}},"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"},"protectedRanges":{"description":"The protected ranges in this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}},"rowGroups":{"description":"All row groups on this sheet, ordered by increasing range start index, then by group depth.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"}},"slicers":{"description":"The slicers on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Slicer"}},"tables":{"description":"The tables on this sheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Table"}}}},"sheets_v4_SheetProperties":{"description":"Properties of a sheet.","type":"object","properties":{"dataSourceSheetProperties":{"$ref":"#/components/schemas/sheets_v4_DataSourceSheetProperties"},"gridProperties":{"$ref":"#/components/schemas/sheets_v4_GridProperties"},"hidden":{"description":"True if the sheet is hidden in the UI, false if it's visible.","type":"boolean"},"index":{"description":"The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in \"before the move\" indexes. For example, if there were three sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.","format":"int32","type":"integer"},"rightToLeft":{"description":"True if the sheet is an RTL sheet instead of an LTR sheet.","type":"boolean"},"sheetId":{"description":"The ID of the sheet. Must be non-negative. This field cannot be changed once set.","format":"int32","type":"integer"},"sheetType":{"description":"The type of sheet. Defaults to GRID. This field cannot be changed once set.","enum":["SHEET_TYPE_UNSPECIFIED","GRID","OBJECT","DATA_SOURCE"],"type":"string"},"tabColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"tabColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"title":{"description":"The name of the sheet.","type":"string"}}},"sheets_v4_Slicer":{"description":"A slicer in a sheet.","type":"object","properties":{"position":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"},"slicerId":{"description":"The ID of the slicer.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_SlicerSpec"}}},"sheets_v4_SlicerSpec":{"description":"The specifications of a slicer.","type":"object","properties":{"applyToPivotTables":{"description":"True if the filter should apply to pivot tables. If not set, default to `True`.","type":"boolean"},"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"columnIndex":{"description":"The zero-based column index in the data table on which the filter is applied to.","format":"int32","type":"integer"},"dataRange":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"filterCriteria":{"$ref":"#/components/schemas/sheets_v4_FilterCriteria"},"horizontalAlignment":{"description":"The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`","enum":["HORIZONTAL_ALIGN_UNSPECIFIED","LEFT","CENTER","RIGHT"],"type":"string"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"title":{"description":"The title of the slicer.","type":"string"}}},"sheets_v4_SortRangeRequest":{"description":"Sorts data in rows based on a sort order per column.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"sortSpecs":{"description":"The sort order per column. Later specifications are used when values are equal in the earlier specifications.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_SortSpec"}}}},"sheets_v4_SortSpec":{"description":"A sort order associated with a specific column or row.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"backgroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"dataSourceColumnReference":{"$ref":"#/components/schemas/sheets_v4_DataSourceColumnReference"},"dimensionIndex":{"description":"The dimension the sort should be applied to.","format":"int32","type":"integer"},"foregroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"foregroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"sortOrder":{"description":"The order data should be sorted.","enum":["SORT_ORDER_UNSPECIFIED","ASCENDING","DESCENDING"],"type":"string"}}},"sheets_v4_SourceAndDestination":{"description":"A combination of a source range and how to extend that source.","type":"object","properties":{"dimension":{"description":"The dimension that data should be filled into.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"fillLength":{"description":"The number of rows or columns that data should be filled into. Positive numbers expand beyond the last row or last column of the source. Negative numbers expand before the first row or first column of the source.","format":"int32","type":"integer"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_Spreadsheet":{"description":"Resource that represents a spreadsheet.","type":"object","properties":{"comments":{"description":"The comment threads associated with the spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the spreadsheet.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"dataSourceSchedules":{"description":"Output only. A list of data source refresh schedules.","readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSourceRefreshSchedule"}},"dataSources":{"description":"A list of external data sources connected with the spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataSource"}},"developerMetadata":{"description":"The developer metadata associated with a spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}},"namedRanges":{"description":"The named ranges defined in a spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}},"properties":{"$ref":"#/components/schemas/sheets_v4_SpreadsheetProperties"},"sheets":{"description":"The sheets that are part of a spreadsheet.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_Sheet"}},"spreadsheetId":{"description":"The ID of the spreadsheet. This field is read-only.","type":"string"},"spreadsheetUrl":{"description":"The url of the spreadsheet. This field is read-only.","type":"string"}}},"sheets_v4_SpreadsheetProperties":{"description":"Properties of a spreadsheet.","type":"object","properties":{"autoRecalc":{"description":"The amount of time to wait before volatile functions are recalculated.","enum":["RECALCULATION_INTERVAL_UNSPECIFIED","ON_CHANGE","MINUTE","HOUR"],"type":"string"},"defaultFormat":{"$ref":"#/components/schemas/sheets_v4_CellFormat"},"importFunctionsExternalUrlAccessAllowed":{"description":"Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the [allowlisting feature](https://support.google.com/a?p=url_allowlist).","type":"boolean"},"iterativeCalculationSettings":{"$ref":"#/components/schemas/sheets_v4_IterativeCalculationSettings"},"locale":{"description":"The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported.","type":"string"},"spreadsheetTheme":{"$ref":"#/components/schemas/sheets_v4_SpreadsheetTheme"},"timeZone":{"description":"The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`.","type":"string"},"title":{"description":"The title of the spreadsheet.","type":"string"}}},"sheets_v4_SpreadsheetTheme":{"description":"Represents spreadsheet theme","type":"object","properties":{"primaryFontFamily":{"description":"Name of the primary font family.","type":"string"},"themeColors":{"description":"The spreadsheet theme color pairs. To update you must provide all theme color pairs.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_ThemeColorPair"}}}},"sheets_v4_Table":{"description":"A table.","type":"object","properties":{"columnProperties":{"description":"The table column properties.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_TableColumnProperties"}},"name":{"description":"The table name. This is unique to all tables in the same spreadsheet.","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rowsProperties":{"$ref":"#/components/schemas/sheets_v4_TableRowsProperties"},"tableId":{"description":"The id of the table.","type":"string"}}},"sheets_v4_TableColumnDataValidationRule":{"description":"A data validation rule for a column in a table.","type":"object","properties":{"condition":{"$ref":"#/components/schemas/sheets_v4_BooleanCondition"}}},"sheets_v4_TableColumnProperties":{"description":"The table column.","type":"object","properties":{"columnIndex":{"description":"The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet.","format":"int32","type":"integer"},"columnName":{"description":"The column name.","type":"string"},"columnType":{"description":"The column type.","enum":["COLUMN_TYPE_UNSPECIFIED","DOUBLE","CURRENCY","PERCENT","DATE","TIME","DATE_TIME","TEXT","BOOLEAN","DROPDOWN","FILES_CHIP","PEOPLE_CHIP","FINANCE_CHIP","PLACE_CHIP","RATINGS_CHIP"],"type":"string"},"dataValidationRule":{"$ref":"#/components/schemas/sheets_v4_TableColumnDataValidationRule"}}},"sheets_v4_TableRowsProperties":{"description":"The table row properties.","type":"object","properties":{"firstBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"footerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"headerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"secondBandColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_TextFormat":{"description":"The format of a run of text in a cell. Absent values indicate that the field isn't specified.","type":"object","properties":{"bold":{"description":"True if the text is bold.","type":"boolean"},"fontFamily":{"description":"The font family.","type":"string"},"fontSize":{"description":"The size of the font.","format":"int32","type":"integer"},"foregroundColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"foregroundColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"italic":{"description":"True if the text is italicized.","type":"boolean"},"link":{"$ref":"#/components/schemas/sheets_v4_Link"},"strikethrough":{"description":"True if the text has a strikethrough.","type":"boolean"},"underline":{"description":"True if the text is underlined.","type":"boolean"}}},"sheets_v4_TextFormatRun":{"description":"A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set.","type":"object","properties":{"format":{"$ref":"#/components/schemas/sheets_v4_TextFormat"},"startIndex":{"description":"The zero-based character index where this run starts, in UTF-16 code units.","format":"int32","type":"integer"}}},"sheets_v4_TextPosition":{"description":"Position settings for text.","type":"object","properties":{"horizontalAlignment":{"description":"Horizontal alignment setting for the piece of text.","enum":["HORIZONTAL_ALIGN_UNSPECIFIED","LEFT","CENTER","RIGHT"],"type":"string"}}},"sheets_v4_TextRotation":{"description":"The rotation applied to text in a cell.","type":"object","properties":{"angle":{"description":"The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counterclockwise direction, whereas for RTL they are in the clockwise direction","format":"int32","type":"integer"},"vertical":{"description":"If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: | V | | e | | r | | t | | i | | c | | a | | l |","type":"boolean"}}},"sheets_v4_TextToColumnsRequest":{"description":"Splits a column of text into multiple columns, based on a delimiter in each cell.","type":"object","properties":{"delimiter":{"description":"The delimiter to use. Used only if delimiterType is CUSTOM.","type":"string"},"delimiterType":{"description":"The delimiter type to use.","enum":["DELIMITER_TYPE_UNSPECIFIED","COMMA","SEMICOLON","PERIOD","SPACE","CUSTOM","AUTODETECT"],"type":"string"},"source":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_ThemeColorPair":{"description":"A pair mapping a spreadsheet theme color type to the concrete color it represents.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"colorType":{"description":"The type of the spreadsheet theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","TEXT","BACKGROUND","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","LINK"],"type":"string"}}},"sheets_v4_TimeOfDay":{"description":"Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.","type":"object","properties":{"hours":{"description":"Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.","format":"int32","type":"integer"},"minutes":{"description":"Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.","format":"int32","type":"integer"},"nanos":{"description":"Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.","format":"int32","type":"integer"},"seconds":{"description":"Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.","format":"int32","type":"integer"}}},"sheets_v4_TreemapChartColorScale":{"description":"A color scale for a treemap chart.","type":"object","properties":{"maxValueColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"maxValueColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"midValueColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"midValueColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"minValueColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"minValueColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"noDataColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"noDataColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"}}},"sheets_v4_TreemapChartSpec":{"description":"A Treemap chart.","type":"object","properties":{"colorData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"colorScale":{"$ref":"#/components/schemas/sheets_v4_TreemapChartColorScale"},"headerColor":{"$ref":"#/components/schemas/sheets_v4_Color"},"headerColorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"hideTooltips":{"description":"True to hide tooltips.","type":"boolean"},"hintedLevels":{"description":"The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.","format":"int32","type":"integer"},"labels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"levels":{"description":"The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.","format":"int32","type":"integer"},"maxValue":{"description":"The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified.","format":"double","type":"number"},"minValue":{"description":"The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified.","format":"double","type":"number"},"parentLabels":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"sizeData":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"textFormat":{"$ref":"#/components/schemas/sheets_v4_TextFormat"}}},"sheets_v4_TrimWhitespaceRequest":{"description":"Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range. This request removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space. If the resulting trimmed text starts with a '+' or '=' character, the text remains as a string value and isn't interpreted as a formula.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_TrimWhitespaceResponse":{"description":"The result of trimming whitespace in cells.","type":"object","properties":{"cellsChangedCount":{"description":"The number of cells that were trimmed of whitespace.","format":"int32","type":"integer"}}},"sheets_v4_UnmergeCellsRequest":{"description":"Unmerges cells in the given range.","type":"object","properties":{"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"}}},"sheets_v4_UpdateBandingRequest":{"description":"Updates properties of the supplied banded range.","type":"object","properties":{"bandedRange":{"$ref":"#/components/schemas/sheets_v4_BandedRange"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `bandedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateBordersRequest":{"description":"Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a border, explicitly set the style to NONE.","type":"object","properties":{"bottom":{"$ref":"#/components/schemas/sheets_v4_Border"},"innerHorizontal":{"$ref":"#/components/schemas/sheets_v4_Border"},"innerVertical":{"$ref":"#/components/schemas/sheets_v4_Border"},"left":{"$ref":"#/components/schemas/sheets_v4_Border"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"right":{"$ref":"#/components/schemas/sheets_v4_Border"},"top":{"$ref":"#/components/schemas/sheets_v4_Border"}}},"sheets_v4_UpdateCellsRequest":{"description":"Updates all cells in a range with new data.","type":"object","properties":{"fields":{"description":"The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"range":{"$ref":"#/components/schemas/sheets_v4_GridRange"},"rows":{"description":"The data to write.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_RowData"}},"start":{"$ref":"#/components/schemas/sheets_v4_GridCoordinate"}}},"sheets_v4_UpdateChartSpecRequest":{"description":"Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)","type":"object","properties":{"chartId":{"description":"The ID of the chart to update.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_ChartSpec"}}},"sheets_v4_UpdateCommentPostRequest":{"description":"Updates a Post in a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"content":{"description":"The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Sheets editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"postId":{"description":"The ID of the post being updated.","type":"string"}}},"sheets_v4_UpdateConditionalFormatRuleRequest":{"description":"Updates a conditional format rule at the given index, or moves a conditional format rule to another index.","type":"object","properties":{"index":{"description":"The zero-based index of the rule that should be replaced or moved.","format":"int32","type":"integer"},"newIndex":{"description":"The zero-based new index the rule should end up at.","format":"int32","type":"integer"},"rule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"},"sheetId":{"description":"The sheet of the rule to move. Required if new_index is set, unused otherwise.","format":"int32","type":"integer"}}},"sheets_v4_UpdateConditionalFormatRuleResponse":{"description":"The result of updating a conditional format rule.","type":"object","properties":{"newIndex":{"description":"The index of the new rule.","format":"int32","type":"integer"},"newRule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"},"oldIndex":{"description":"The old index of the rule. Not set if a rule was replaced (because it is the same as new_index).","format":"int32","type":"integer"},"oldRule":{"$ref":"#/components/schemas/sheets_v4_ConditionalFormatRule"}}},"sheets_v4_UpdateDataSourceRequest":{"description":"Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source.","type":"object","properties":{"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dataSource` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateDataSourceResponse":{"description":"The response from updating data source.","type":"object","properties":{"dataExecutionStatus":{"$ref":"#/components/schemas/sheets_v4_DataExecutionStatus"},"dataSource":{"$ref":"#/components/schemas/sheets_v4_DataSource"}}},"sheets_v4_UpdateDeveloperMetadataRequest":{"description":"A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update.","type":"object","properties":{"dataFilters":{"description":"The filters matching the developer metadata entries to update.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DataFilter"}},"developerMetadata":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `developerMetadata` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateDeveloperMetadataResponse":{"description":"The response from updating developer metadata.","type":"object","properties":{"developerMetadata":{"description":"The updated developer metadata.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_DeveloperMetadata"}}}},"sheets_v4_UpdateDimensionGroupRequest":{"description":"Updates the state of the specified group.","type":"object","properties":{"dimensionGroup":{"$ref":"#/components/schemas/sheets_v4_DimensionGroup"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `dimensionGroup` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"}}},"sheets_v4_UpdateDimensionPropertiesRequest":{"description":"Updates properties of dimensions within the specified range.","type":"object","properties":{"dataSourceSheetRange":{"$ref":"#/components/schemas/sheets_v4_DataSourceSheetDimensionRange"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"properties":{"$ref":"#/components/schemas/sheets_v4_DimensionProperties"},"range":{"$ref":"#/components/schemas/sheets_v4_DimensionRange"}}},"sheets_v4_UpdateEmbeddedObjectBorderRequest":{"description":"Updates an embedded object's border property.","type":"object","properties":{"border":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectBorder"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `border` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The ID of the embedded object to update.","format":"int32","type":"integer"}}},"sheets_v4_UpdateEmbeddedObjectPositionRequest":{"description":"Update an embedded object's position (such as a moving or resizing a chart or image).","type":"object","properties":{"fields":{"description":"The fields of OverlayPosition that should be updated when setting a new position. Used only if newPosition.overlayPosition is set, in which case at least one field must be specified. The root `newPosition.overlayPosition` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"newPosition":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"},"objectId":{"description":"The ID of the object to moved.","format":"int32","type":"integer"}}},"sheets_v4_UpdateEmbeddedObjectPositionResponse":{"description":"The result of updating an embedded object's position.","type":"object","properties":{"position":{"$ref":"#/components/schemas/sheets_v4_EmbeddedObjectPosition"}}},"sheets_v4_UpdateFilterViewRequest":{"description":"Updates properties of the filter view.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `filter` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"filter":{"$ref":"#/components/schemas/sheets_v4_FilterView"}}},"sheets_v4_UpdateNamedRangeRequest":{"description":"Updates properties of the named range with the specified namedRangeId.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `namedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"namedRange":{"$ref":"#/components/schemas/sheets_v4_NamedRange"}}},"sheets_v4_UpdateProtectedRangeRequest":{"description":"Updates an existing protected range with the specified protectedRangeId.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `protectedRange` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"protectedRange":{"$ref":"#/components/schemas/sheets_v4_ProtectedRange"}}},"sheets_v4_UpdateSheetPropertiesRequest":{"description":"Updates properties of the sheet with the specified sheetId.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"properties":{"$ref":"#/components/schemas/sheets_v4_SheetProperties"}}},"sheets_v4_UpdateSlicerSpecRequest":{"description":"Updates a slicer's specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `SlicerSpec` is implied and should not be specified. A single \"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"slicerId":{"description":"The id of the slicer to update.","format":"int32","type":"integer"},"spec":{"$ref":"#/components/schemas/sheets_v4_SlicerSpec"}}},"sheets_v4_UpdateSpreadsheetPropertiesRequest":{"description":"Updates properties of a spreadsheet.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root 'properties' is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"properties":{"$ref":"#/components/schemas/sheets_v4_SpreadsheetProperties"}}},"sheets_v4_UpdateTableRequest":{"description":"Updates a table in the spreadsheet.","type":"object","properties":{"fields":{"description":"Required. The fields that should be updated. At least one field must be specified. The root `table` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.","format":"google-fieldmask","type":"string"},"table":{"$ref":"#/components/schemas/sheets_v4_Table"}}},"sheets_v4_UpdateValuesByDataFilterResponse":{"description":"The response when updating a range of values by a data filter in a spreadsheet.","type":"object","properties":{"dataFilter":{"$ref":"#/components/schemas/sheets_v4_DataFilter"},"updatedCells":{"description":"The number of cells updated.","format":"int32","type":"integer"},"updatedColumns":{"description":"The number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"updatedData":{"$ref":"#/components/schemas/sheets_v4_ValueRange"},"updatedRange":{"description":"The range (in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell)) that updates were applied to.","type":"string"},"updatedRows":{"description":"The number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"}}},"sheets_v4_UpdateValuesResponse":{"description":"The response when updating a range of values in a spreadsheet.","type":"object","properties":{"spreadsheetId":{"description":"The spreadsheet the updates were applied to.","type":"string"},"updatedCells":{"description":"The number of cells updated.","format":"int32","type":"integer"},"updatedColumns":{"description":"The number of columns where at least one cell in the column was updated.","format":"int32","type":"integer"},"updatedData":{"$ref":"#/components/schemas/sheets_v4_ValueRange"},"updatedRange":{"description":"The range (in A1 notation) that updates were applied to.","type":"string"},"updatedRows":{"description":"The number of rows where at least one cell in the row was updated.","format":"int32","type":"integer"}}},"sheets_v4_ValueRange":{"description":"Data within a range of the spreadsheet.","type":"object","properties":{"majorDimension":{"description":"The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.","enum":["DIMENSION_UNSPECIFIED","ROWS","COLUMNS"],"type":"string"},"range":{"description":"The range the values cover, in [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.","type":"string"},"values":{"description":"The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.","type":"array","items":{"type":"array","items":{}}}}},"sheets_v4_WaterfallChartColumnStyle":{"description":"Styles for a waterfall chart column.","type":"object","properties":{"color":{"$ref":"#/components/schemas/sheets_v4_Color"},"colorStyle":{"$ref":"#/components/schemas/sheets_v4_ColorStyle"},"label":{"description":"The label of the column's legend.","type":"string"}}},"sheets_v4_WaterfallChartCustomSubtotal":{"description":"A custom subtotal column for a waterfall chart series.","type":"object","properties":{"dataIsSubtotal":{"description":"True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point.","type":"boolean"},"label":{"description":"A label for the subtotal column.","type":"string"},"subtotalIndex":{"description":"The zero-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has three data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with.","format":"int32","type":"integer"}}},"sheets_v4_WaterfallChartDomain":{"description":"The domain of a waterfall chart.","type":"object","properties":{"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"reversed":{"description":"True to reverse the order of the domain values (horizontal axis).","type":"boolean"}}},"sheets_v4_WaterfallChartSeries":{"description":"A single series of data for a waterfall chart.","type":"object","properties":{"customSubtotals":{"description":"Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartCustomSubtotal"}},"data":{"$ref":"#/components/schemas/sheets_v4_ChartData"},"dataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"},"hideTrailingSubtotal":{"description":"True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series.","type":"boolean"},"negativeColumnsStyle":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartColumnStyle"},"positiveColumnsStyle":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartColumnStyle"},"subtotalColumnsStyle":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartColumnStyle"}}},"sheets_v4_WaterfallChartSpec":{"description":"A waterfall chart.","type":"object","properties":{"connectorLineStyle":{"$ref":"#/components/schemas/sheets_v4_LineStyle"},"domain":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartDomain"},"firstValueIsTotal":{"description":"True to interpret the first value as a total.","type":"boolean"},"hideConnectorLines":{"description":"True to hide connector lines between columns.","type":"boolean"},"series":{"description":"The data this waterfall chart is visualizing.","type":"array","items":{"$ref":"#/components/schemas/sheets_v4_WaterfallChartSeries"}},"stackedType":{"description":"The stacked type.","enum":["WATERFALL_STACKED_TYPE_UNSPECIFIED","STACKED","SEQUENTIAL"],"type":"string"},"totalDataLabel":{"$ref":"#/components/schemas/sheets_v4_DataLabel"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/spreadsheets":"See, edit, create, and delete all your Google Sheets spreadsheets","https://www.googleapis.com/auth/drive.file":"See, edit, create, and delete only the specific Google Drive files you use with this app","https://www.googleapis.com/auth/spreadsheets.readonly":"See all your Google Sheets spreadsheets"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/drive.file"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/sheets/v4/rest","service":"sheets","version":"v4"}]}} \ No newline at end of file diff --git a/public/specs/google/google-slides.json b/public/specs/google/google-slides.json index 3aab27e7..ace75d5b 100644 --- a/public/specs/google/google-slides.json +++ b/public/specs/google/google-slides.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Slides API","version":"v1","description":"Reads and writes Google Slides presentations."},"servers":[{"url":"https://slides.googleapis.com/"}],"paths":{"/v1/presentations":{"post":{"operationId":"slides.presentations.create","x-executor-toolPath":"slides.presentations.create","tags":["Google Slides API"],"description":"Creates a blank presentation using the title given in the request. If a `presentationId` is provided, it is used as the ID of the new presentation. Otherwise, a new ID is generated. Other fields in the request, including any provided content, are ignored. Returns the created presentation.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Presentation"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Presentation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}":{"get":{"operationId":"slides.presentations.get","x-executor-toolPath":"slides.presentations.get","tags":["Google Slides API"],"description":"Gets the latest version of the specified presentation.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The ID of the presentation to retrieve.","schema":{"description":"The ID of the presentation to retrieve.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the presentation. This allows viewing the presentation with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [Developer Preview](https://developers.google.com/workspace/preview).","schema":{"description":"The comments view mode to apply to the presentation. This allows viewing the presentation with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Presentation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}/pages/{pageObjectId}":{"get":{"operationId":"slides.presentations.pages.get","x-executor-toolPath":"slides.presentations.pages.get","tags":["Google Slides API"],"description":"Gets the latest version of the specified page in the presentation.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The ID of the presentation to retrieve.","schema":{"description":"The ID of the presentation to retrieve.","type":"string"}},{"name":"pageObjectId","in":"path","required":true,"description":"The object ID of the page to retrieve.","schema":{"description":"The object ID of the page to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the page. This allows viewing the page with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [Developer Preview](https://developers.google.com/workspace/preview).","schema":{"description":"The comments view mode to apply to the page. This allows viewing the page with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Page"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail":{"get":{"operationId":"slides.presentations.pages.getThumbnail","x-executor-toolPath":"slides.presentations.pages.getThumbnail","tags":["Google Slides API"],"description":"Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](https://developers.google.com/workspace/slides/limits) for quota purposes.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The ID of the presentation to retrieve.","schema":{"description":"The ID of the presentation to retrieve.","type":"string"}},{"name":"pageObjectId","in":"path","required":true,"description":"The object ID of the page whose thumbnail to retrieve.","schema":{"description":"The object ID of the page whose thumbnail to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"thumbnailProperties.mimeType","in":"query","required":false,"description":"The optional mime type of the thumbnail image. If you don't specify the mime type, the mime type defaults to PNG.","schema":{"description":"The optional mime type of the thumbnail image. If you don't specify the mime type, the mime type defaults to PNG.","enum":["PNG"],"type":"string"},"style":"form","explode":false},{"name":"thumbnailProperties.thumbnailSize","in":"query","required":false,"description":"The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image.","schema":{"description":"The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image.","enum":["THUMBNAIL_SIZE_UNSPECIFIED","LARGE","MEDIUM","SMALL","WIDTH2000_PX"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Thumbnail"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}:batchUpdate":{"post":{"operationId":"slides.presentations.batchUpdate","x-executor-toolPath":"slides.presentations.batchUpdate","tags":["Google Slides API"],"description":"Applies one or more updates to the presentation. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies: the reply to the third request, and another empty reply, in that order. Because other users may be editing the presentation, the presentation might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the presentation should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The presentation to apply the updates to.","schema":{"description":"The presentation to apply the updates to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_BatchUpdatePresentationRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_BatchUpdatePresentationResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations"]}}},"components":{"schemas":{"slides_v1_AddCommentReplyRequest":{"description":"Inserts a reply Post into a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread to add the reply to.","type":"string"},"post":{"$ref":"#/components/schemas/slides_v1_Post"}}},"slides_v1_AddCommentReplyResponse":{"description":"The result of creating a reply. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"post":{"$ref":"#/components/schemas/slides_v1_Post"}}},"slides_v1_AffineTransform":{"description":"AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements.","type":"object","properties":{"scaleX":{"description":"The X coordinate scaling element.","format":"double","type":"number"},"scaleY":{"description":"The Y coordinate scaling element.","format":"double","type":"number"},"shearX":{"description":"The X coordinate shearing element.","format":"double","type":"number"},"shearY":{"description":"The Y coordinate shearing element.","format":"double","type":"number"},"translateX":{"description":"The X coordinate translation element.","format":"double","type":"number"},"translateY":{"description":"The Y coordinate translation element.","format":"double","type":"number"},"unit":{"description":"The units for translate elements.","enum":["UNIT_UNSPECIFIED","EMU","PT"],"type":"string"}}},"slides_v1_AutoText":{"description":"A TextElement kind that represents auto text.","type":"object","properties":{"content":{"description":"The rendered content of this auto text, if available.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_TextStyle"},"type":{"description":"The type of this auto text.","enum":["TYPE_UNSPECIFIED","SLIDE_NUMBER"],"type":"string"}}},"slides_v1_Autofit":{"description":"The autofit properties of a Shape. This property is only set for shapes that allow text.","type":"object","properties":{"autofitType":{"description":"The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case, the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values.","enum":["AUTOFIT_TYPE_UNSPECIFIED","NONE","TEXT_AUTOFIT","SHAPE_AUTOFIT"],"type":"string"},"fontScale":{"description":"The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that's rendered in the editor. This property is read-only.","format":"float","type":"number"},"lineSpacingReduction":{"description":"The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that's rendered in the editor. This property is read-only.","format":"float","type":"number"}}},"slides_v1_BatchUpdatePresentationRequest":{"description":"Request message for PresentationsService.BatchUpdatePresentation.","type":"object","properties":{"requests":{"description":"A list of updates to apply to the presentation.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Request"}},"writeControl":{"$ref":"#/components/schemas/slides_v1_WriteControl"}}},"slides_v1_BatchUpdatePresentationResponse":{"description":"Response message from a batch update.","type":"object","properties":{"commentUpdateState":{"description":"Whether comment updates were applied in the batch request. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENT_UPDATE_STATE_UNSPECIFIED","NO_UPDATES_REQUESTED","ALL_SAVED","ALL_FAILED_UNKNOWN_REASON"],"type":"string"},"presentationId":{"description":"The presentation the updates were applied to.","type":"string"},"replies":{"description":"The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Response"}},"writeControl":{"$ref":"#/components/schemas/slides_v1_WriteControl"}}},"slides_v1_Bullet":{"description":"Describes the bullet of a paragraph.","type":"object","properties":{"bulletStyle":{"$ref":"#/components/schemas/slides_v1_TextStyle"},"glyph":{"description":"The rendered bullet glyph for this paragraph.","type":"string"},"listId":{"description":"The ID of the list this paragraph belongs to.","type":"string"},"nestingLevel":{"description":"The nesting level of this paragraph in the list.","format":"int32","type":"integer"}}},"slides_v1_ColorScheme":{"description":"The palette of predefined colors for a page.","type":"object","properties":{"colors":{"description":"The ThemeColorType and corresponding concrete color pairs.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_ThemeColorPair"}}}},"slides_v1_ColorStop":{"description":"A color and position in a gradient band.","type":"object","properties":{"alpha":{"description":"The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque.","format":"float","type":"number"},"color":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"},"position":{"description":"The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0].","format":"float","type":"number"}}},"slides_v1_CommentAnchor":{"description":"Contains a list of all locations in a `Page` that are anchored to a CommentThread via the same anchorId. Multiple separate anchors may refer to the same location, either within a `Page` or across different pages, [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"Output only. The unique ID of the comment anchor.","type":"string"},"objectAnchors":{"description":"Output only. All object ID-based locations within a page that refer to the anchor ID.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_ObjectAnchor"}}}},"slides_v1_CommentThread":{"description":"Represents a single comment thread inside a presentation. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anchorId":{"description":"The ID of the CommentAnchor in the presentation that this thread is tied to.","type":"string"},"commentId":{"description":"The unique ID of the comment thread.","type":"string"},"headPost":{"$ref":"#/components/schemas/slides_v1_Post"},"plainTextQuote":{"description":"The quoted text from the page element when the comment was created, formatted as plain-text.","type":"string"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Post"}},"status":{"description":"Whether the thread is open or resolved.","enum":["STATUS_UNSPECIFIED","OPEN","RESOLVED"],"type":"string"}}},"slides_v1_CreateImageRequest":{"description":"Creates an image.","type":"object","properties":{"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"},"url":{"description":"The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50 MB in size, can't exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF formats. The provided URL must be publicly accessible and up to 2 KB in length. The URL is saved with the image, and exposed through the Image.source_url field.","type":"string"}}},"slides_v1_CreateImageResponse":{"description":"The result of creating an image.","type":"object","properties":{"objectId":{"description":"The object ID of the created image.","type":"string"}}},"slides_v1_CreateLineRequest":{"description":"Creates a line.","type":"object","properties":{"category":{"description":"The category of the line to be created. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence. If you do not specify a value for `category`, but specify a value for `line_category`, then the specified `line_category` value is used. If you do not specify either, then STRAIGHT is used.","enum":["LINE_CATEGORY_UNSPECIFIED","STRAIGHT","BENT","CURVED"],"type":"string"},"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"lineCategory":{"description":"The category of the line to be created. *Deprecated*: use `category` instead. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence.","enum":["STRAIGHT","BENT","CURVED"],"type":"string"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"}}},"slides_v1_CreateLineResponse":{"description":"The result of creating a line.","type":"object","properties":{"objectId":{"description":"The object ID of the created line.","type":"string"}}},"slides_v1_CreateParagraphBulletsRequest":{"description":"Creates bullets for all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list.","type":"object","properties":{"bulletPreset":{"description":"The kinds of bullet glyphs to be used. Defaults to the `BULLET_DISC_CIRCLE_SQUARE` preset.","enum":["BULLET_DISC_CIRCLE_SQUARE","BULLET_DIAMONDX_ARROW3D_SQUARE","BULLET_CHECKBOX","BULLET_ARROW_DIAMOND_DISC","BULLET_STAR_CIRCLE_SQUARE","BULLET_ARROW3D_CIRCLE_SQUARE","BULLET_LEFTTRIANGLE_DIAMOND_DISC","BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE","BULLET_DIAMOND_CIRCLE_SQUARE","NUMBERED_DIGIT_ALPHA_ROMAN","NUMBERED_DIGIT_ALPHA_ROMAN_PARENS","NUMBERED_DIGIT_NESTED","NUMBERED_UPPERALPHA_ALPHA_ROMAN","NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT","NUMBERED_ZERODIGIT_ALPHA_ROMAN"],"type":"string"},"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the shape or table containing the text to add bullets to.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_CreateShapeRequest":{"description":"Creates a new shape.","type":"object","properties":{"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If empty, a unique identifier will be generated.","type":"string"},"shapeType":{"description":"The shape type.","enum":["TYPE_UNSPECIFIED","TEXT_BOX","RECTANGLE","ROUND_RECTANGLE","ELLIPSE","ARC","BENT_ARROW","BENT_UP_ARROW","BEVEL","BLOCK_ARC","BRACE_PAIR","BRACKET_PAIR","CAN","CHEVRON","CHORD","CLOUD","CORNER","CUBE","CURVED_DOWN_ARROW","CURVED_LEFT_ARROW","CURVED_RIGHT_ARROW","CURVED_UP_ARROW","DECAGON","DIAGONAL_STRIPE","DIAMOND","DODECAGON","DONUT","DOUBLE_WAVE","DOWN_ARROW","DOWN_ARROW_CALLOUT","FOLDED_CORNER","FRAME","HALF_FRAME","HEART","HEPTAGON","HEXAGON","HOME_PLATE","HORIZONTAL_SCROLL","IRREGULAR_SEAL_1","IRREGULAR_SEAL_2","LEFT_ARROW","LEFT_ARROW_CALLOUT","LEFT_BRACE","LEFT_BRACKET","LEFT_RIGHT_ARROW","LEFT_RIGHT_ARROW_CALLOUT","LEFT_RIGHT_UP_ARROW","LEFT_UP_ARROW","LIGHTNING_BOLT","MATH_DIVIDE","MATH_EQUAL","MATH_MINUS","MATH_MULTIPLY","MATH_NOT_EQUAL","MATH_PLUS","MOON","NO_SMOKING","NOTCHED_RIGHT_ARROW","OCTAGON","PARALLELOGRAM","PENTAGON","PIE","PLAQUE","PLUS","QUAD_ARROW","QUAD_ARROW_CALLOUT","RIBBON","RIBBON_2","RIGHT_ARROW","RIGHT_ARROW_CALLOUT","RIGHT_BRACE","RIGHT_BRACKET","ROUND_1_RECTANGLE","ROUND_2_DIAGONAL_RECTANGLE","ROUND_2_SAME_RECTANGLE","RIGHT_TRIANGLE","SMILEY_FACE","SNIP_1_RECTANGLE","SNIP_2_DIAGONAL_RECTANGLE","SNIP_2_SAME_RECTANGLE","SNIP_ROUND_RECTANGLE","STAR_10","STAR_12","STAR_16","STAR_24","STAR_32","STAR_4","STAR_5","STAR_6","STAR_7","STAR_8","STRIPED_RIGHT_ARROW","SUN","TRAPEZOID","TRIANGLE","UP_ARROW","UP_ARROW_CALLOUT","UP_DOWN_ARROW","UTURN_ARROW","VERTICAL_SCROLL","WAVE","WEDGE_ELLIPSE_CALLOUT","WEDGE_RECTANGLE_CALLOUT","WEDGE_ROUND_RECTANGLE_CALLOUT","FLOW_CHART_ALTERNATE_PROCESS","FLOW_CHART_COLLATE","FLOW_CHART_CONNECTOR","FLOW_CHART_DECISION","FLOW_CHART_DELAY","FLOW_CHART_DISPLAY","FLOW_CHART_DOCUMENT","FLOW_CHART_EXTRACT","FLOW_CHART_INPUT_OUTPUT","FLOW_CHART_INTERNAL_STORAGE","FLOW_CHART_MAGNETIC_DISK","FLOW_CHART_MAGNETIC_DRUM","FLOW_CHART_MAGNETIC_TAPE","FLOW_CHART_MANUAL_INPUT","FLOW_CHART_MANUAL_OPERATION","FLOW_CHART_MERGE","FLOW_CHART_MULTIDOCUMENT","FLOW_CHART_OFFLINE_STORAGE","FLOW_CHART_OFFPAGE_CONNECTOR","FLOW_CHART_ONLINE_STORAGE","FLOW_CHART_OR","FLOW_CHART_PREDEFINED_PROCESS","FLOW_CHART_PREPARATION","FLOW_CHART_PROCESS","FLOW_CHART_PUNCHED_CARD","FLOW_CHART_PUNCHED_TAPE","FLOW_CHART_SORT","FLOW_CHART_SUMMING_JUNCTION","FLOW_CHART_TERMINATOR","ARROW_EAST","ARROW_NORTH_EAST","ARROW_NORTH","SPEECH","STARBURST","TEARDROP","ELLIPSE_RIBBON","ELLIPSE_RIBBON_2","CLOUD_CALLOUT","CUSTOM"],"type":"string"}}},"slides_v1_CreateShapeResponse":{"description":"The result of creating a shape.","type":"object","properties":{"objectId":{"description":"The object ID of the created shape.","type":"string"}}},"slides_v1_CreateSheetsChartRequest":{"description":"Creates an embedded Google Sheets chart. NOTE: Chart creation requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive.file, or drive OAuth scopes.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet.","format":"int32","type":"integer"},"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"linkingMode":{"description":"The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked.","enum":["NOT_LINKED_IMAGE","LINKED"],"type":"string"},"objectId":{"description":"A user-supplied object ID. If specified, the ID must be unique among all pages and page elements in the presentation. The ID should start with a word character [a-zA-Z0-9_] and then followed by any number of the following characters [a-zA-Z0-9_-:]. The length of the ID should not be less than 5 or greater than 50. If empty, a unique identifier will be generated.","type":"string"},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the chart. You might need to add a resource key to the HTTP header for a subset of old files. For more information, see [Access link-shared files using resource keys](https://developers.google.com/drive/api/v3/resource-keys).","type":"string"}}},"slides_v1_CreateSheetsChartResponse":{"description":"The result of creating an embedded Google Sheets chart.","type":"object","properties":{"objectId":{"description":"The object ID of the created chart.","type":"string"}}},"slides_v1_CreateSlideRequest":{"description":"Creates a slide.","type":"object","properties":{"insertionIndex":{"description":"The optional zero-based index indicating where to insert the slides. If you don't specify an index, the slide is created at the end.","format":"int32","type":"integer"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The ID length must be between 5 and 50 characters, inclusive. If you don't specify an ID, a unique one is generated.","type":"string"},"placeholderIdMappings":{"description":"An optional list of object ID mappings from the placeholder(s) on the layout to the placeholders that are created on the slide from the specified layout. Can only be used when `slide_layout_reference` is specified.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_LayoutPlaceholderIdMapping"}},"slideLayoutReference":{"$ref":"#/components/schemas/slides_v1_LayoutReference"}}},"slides_v1_CreateSlideResponse":{"description":"The result of creating a slide.","type":"object","properties":{"objectId":{"description":"The object ID of the created slide.","type":"string"}}},"slides_v1_CreateTableRequest":{"description":"Creates a new table.","type":"object","properties":{"columns":{"description":"Number of columns in the table.","format":"int32","type":"integer"},"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"},"rows":{"description":"Number of rows in the table.","format":"int32","type":"integer"}}},"slides_v1_CreateTableResponse":{"description":"The result of creating a table.","type":"object","properties":{"objectId":{"description":"The object ID of the created table.","type":"string"}}},"slides_v1_CreateVideoRequest":{"description":"Creates a video. NOTE: Creating a video from Google Drive requires that the requesting app have at least one of the drive, drive.readonly, or drive.file OAuth scopes.","type":"object","properties":{"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"id":{"description":"The video source's unique identifier for this video. e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is 7U3axjORYZ0. For a Google Drive video https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. To access a Google Drive video file, you might need to add a resource key to the HTTP header for a subset of old files. For more information, see [Access link-shared files using resource keys](https://developers.google.com/drive/api/v3/resource-keys).","type":"string"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"},"source":{"description":"The video source.","enum":["SOURCE_UNSPECIFIED","YOUTUBE","DRIVE"],"type":"string"}}},"slides_v1_CreateVideoResponse":{"description":"The result of creating a video.","type":"object","properties":{"objectId":{"description":"The object ID of the created video.","type":"string"}}},"slides_v1_CropProperties":{"description":"The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container.","type":"object","properties":{"angle":{"description":"The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset.","format":"float","type":"number"},"bottomOffset":{"description":"The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height.","format":"float","type":"number"},"leftOffset":{"description":"The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width.","format":"float","type":"number"},"rightOffset":{"description":"The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width.","format":"float","type":"number"},"topOffset":{"description":"The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height.","format":"float","type":"number"}}},"slides_v1_DeleteCommentReplyRequest":{"description":"Deletes a reply Post from a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains a comment action. - The reply post contains an assignee. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"postId":{"description":"The ID of the reply Post being deleted.","type":"string"}}},"slides_v1_DeleteCommentRequest":{"description":"Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread that is being deleted.","type":"string"}}},"slides_v1_DeleteObjectRequest":{"description":"Deletes an object, either pages or page elements, from the presentation.","type":"object","properties":{"objectId":{"description":"The object ID of the page or page element to delete. If after a delete operation a group contains only 1 or no page elements, the group is also deleted. If a placeholder is deleted on a layout, any empty inheriting placeholders are also deleted.","type":"string"}}},"slides_v1_DeleteParagraphBulletsRequest":{"description":"Deletes bullets from all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the shape or table containing the text to delete bullets from.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_DeleteTableColumnRequest":{"description":"Deletes a column from a table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"tableObjectId":{"description":"The table to delete columns from.","type":"string"}}},"slides_v1_DeleteTableRowRequest":{"description":"Deletes a row from a table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"tableObjectId":{"description":"The table to delete rows from.","type":"string"}}},"slides_v1_DeleteTextRequest":{"description":"Deletes text from a shape or a table cell.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the shape or table from which the text will be deleted.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_Dimension":{"description":"A magnitude in a single direction in the specified units.","type":"object","properties":{"magnitude":{"description":"The magnitude.","format":"double","type":"number"},"unit":{"description":"The units for magnitude.","enum":["UNIT_UNSPECIFIED","EMU","PT"],"type":"string"}}},"slides_v1_DuplicateObjectRequest":{"description":"Duplicates a slide or page element. When duplicating a slide, the duplicate slide will be created immediately following the specified slide. When duplicating a page element, the duplicate will be placed on the same page at the same position as the original.","type":"object","properties":{"objectId":{"description":"The ID of the object to duplicate.","type":"string"},"objectIds":{"description":"The object being duplicated may contain other objects, for example when duplicating a slide or a group page element. This map defines how the IDs of duplicated objects are generated: the keys are the IDs of the original objects and its values are the IDs that will be assigned to the corresponding duplicate object. The ID of the source object's duplicate may be specified in this map as well, using the same value of the `object_id` field as a key and the newly desired ID as the value. All keys must correspond to existing IDs in the presentation. All values must be unique in the presentation and must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or greater than 50. If any IDs of source objects are omitted from the map, a new random ID will be assigned. If the map is empty or unset, all duplicate objects will receive a new random ID.","type":"object","additionalProperties":{"type":"string"}}}},"slides_v1_DuplicateObjectResponse":{"description":"The response of duplicating an object.","type":"object","properties":{"objectId":{"description":"The ID of the new duplicate object.","type":"string"}}},"slides_v1_Group":{"description":"A PageElement kind representing a joined collection of PageElements.","type":"object","properties":{"children":{"description":"The collection of elements in the group. The minimum size of a group is 2.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_PageElement"}}}},"slides_v1_GroupObjectsRequest":{"description":"Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.","type":"object","properties":{"childrenObjectIds":{"description":"The object IDs of the objects to group. Only page elements can be grouped. There should be at least two page elements on the same page that are not already in another group. Some page elements, such as videos, tables and placeholders cannot be grouped.","type":"array","items":{"type":"string"}},"groupObjectId":{"description":"A user-supplied object ID for the group to be created. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"}}},"slides_v1_GroupObjectsResponse":{"description":"The result of grouping objects.","type":"object","properties":{"objectId":{"description":"The object ID of the created group.","type":"string"}}},"slides_v1_Image":{"description":"A PageElement kind representing an image.","type":"object","properties":{"contentUrl":{"description":"An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change.","type":"string"},"imageProperties":{"$ref":"#/components/schemas/slides_v1_ImageProperties"},"placeholder":{"$ref":"#/components/schemas/slides_v1_Placeholder"},"sourceUrl":{"description":"The source URL is the URL used to insert the image. The source URL can be empty.","type":"string"}}},"slides_v1_ImageProperties":{"description":"The properties of the Image.","type":"object","properties":{"brightness":{"description":"The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only.","format":"float","type":"number"},"contrast":{"description":"The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only.","format":"float","type":"number"},"cropProperties":{"$ref":"#/components/schemas/slides_v1_CropProperties"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"recolor":{"$ref":"#/components/schemas/slides_v1_Recolor"},"shadow":{"$ref":"#/components/schemas/slides_v1_Shadow"},"transparency":{"description":"The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only.","format":"float","type":"number"}}},"slides_v1_InsertCommentRequest":{"description":"Inserts a CommentThread into the presentation. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmailAddress":{"description":"Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units.","type":"string"},"content":{"description":"The text of the comment, as plain text. This text content will be handled similarly to comments created in the Slides editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"objectId":{"description":"The object ID of the Page or PageElement that is tied to this comment. If the specified object_id is a Group, the comment will be anchored to at most 100 of the group's non-group descendants.","type":"string"},"shapeTextAnchor":{"$ref":"#/components/schemas/slides_v1_ShapeTextAnchor"},"tableAnchor":{"$ref":"#/components/schemas/slides_v1_TableAnchor"},"tableCellTextAnchor":{"$ref":"#/components/schemas/slides_v1_TableCellTextAnchor"}}},"slides_v1_InsertCommentResponse":{"description":"The result of creating a comment. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentThread":{"$ref":"#/components/schemas/slides_v1_CommentThread"}}},"slides_v1_InsertTableColumnsRequest":{"description":"Inserts columns into a table. Other columns in the table will be resized to fit the new column.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"insertRight":{"description":"Whether to insert new columns to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left.","type":"boolean"},"number":{"description":"The number of columns to be inserted. Maximum 20 per request.","format":"int32","type":"integer"},"tableObjectId":{"description":"The table to insert columns into.","type":"string"}}},"slides_v1_InsertTableRowsRequest":{"description":"Inserts rows into a table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"insertBelow":{"description":"Whether to insert new rows below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell.","type":"boolean"},"number":{"description":"The number of rows to be inserted. Maximum 20 per request.","format":"int32","type":"integer"},"tableObjectId":{"description":"The table to insert rows into.","type":"string"}}},"slides_v1_InsertTextRequest":{"description":"Inserts text into a shape or a table cell.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"insertionIndex":{"description":"The index where the text will be inserted, in Unicode code units, based on TextElement indexes. The index is zero-based and is computed from the start of the string. The index may be adjusted to prevent insertions inside Unicode grapheme clusters. In these cases, the text will be inserted immediately after the grapheme cluster.","format":"int32","type":"integer"},"objectId":{"description":"The object ID of the shape or table where the text will be inserted.","type":"string"},"text":{"description":"The text to be inserted. Inserting a newline character will implicitly create a new ParagraphMarker at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text will be added to the TextRun that exists at the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text.","type":"string"}}},"slides_v1_LayoutPlaceholderIdMapping":{"description":"The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout.","type":"object","properties":{"layoutPlaceholder":{"$ref":"#/components/schemas/slides_v1_Placeholder"},"layoutPlaceholderObjectId":{"description":"The object ID of the placeholder on a layout that will be applied to a slide.","type":"string"},"objectId":{"description":"A user-supplied object ID for the placeholder identified above that to be created onto a slide. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"}}},"slides_v1_LayoutProperties":{"description":"The properties of Page are only relevant for pages with page_type LAYOUT.","type":"object","properties":{"displayName":{"description":"The human-readable name of the layout.","type":"string"},"masterObjectId":{"description":"The object ID of the master that this layout is based on.","type":"string"},"name":{"description":"The name of the layout.","type":"string"}}},"slides_v1_LayoutReference":{"description":"Slide layout reference. This may reference either: - A predefined layout - One of the layouts in the presentation.","type":"object","properties":{"layoutId":{"description":"Layout ID: the object ID of one of the layouts in the presentation.","type":"string"},"predefinedLayout":{"description":"Predefined layout.","enum":["PREDEFINED_LAYOUT_UNSPECIFIED","BLANK","CAPTION_ONLY","TITLE","TITLE_AND_BODY","TITLE_AND_TWO_COLUMNS","TITLE_ONLY","SECTION_HEADER","SECTION_TITLE_AND_DESCRIPTION","ONE_COLUMN_TEXT","MAIN_POINT","BIG_NUMBER"],"type":"string"}}},"slides_v1_Line":{"description":"A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector.","type":"object","properties":{"lineCategory":{"description":"The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest.","enum":["LINE_CATEGORY_UNSPECIFIED","STRAIGHT","BENT","CURVED"],"type":"string"},"lineProperties":{"$ref":"#/components/schemas/slides_v1_LineProperties"},"lineType":{"description":"The type of the line.","enum":["TYPE_UNSPECIFIED","STRAIGHT_CONNECTOR_1","BENT_CONNECTOR_2","BENT_CONNECTOR_3","BENT_CONNECTOR_4","BENT_CONNECTOR_5","CURVED_CONNECTOR_2","CURVED_CONNECTOR_3","CURVED_CONNECTOR_4","CURVED_CONNECTOR_5","STRAIGHT_LINE"],"type":"string"}}},"slides_v1_LineConnection":{"description":"The properties for one end of a Line connection.","type":"object","properties":{"connectedObjectId":{"description":"The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line.","type":"string"},"connectionSiteIndex":{"description":"The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in both the description of the \"cxn\" attribute in section 20.1.9.9 and \"Annex H. Example Predefined DrawingML Shape and Text Geometries\" of \"Office Open XML File Formats - Fundamentals and Markup Language Reference\", part 1 of [ECMA-376 5th edition](https://ecma-international.org/publications-and-standards/standards/ecma-376/). The position of each connection site can also be viewed from Slides editor.","format":"int32","type":"integer"}}},"slides_v1_LineFill":{"description":"The fill of the line.","type":"object","properties":{"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_LineProperties":{"description":"The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor.","type":"object","properties":{"dashStyle":{"description":"The dash style of the line.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH","DASH_DOT","LONG_DASH","LONG_DASH_DOT"],"type":"string"},"endArrow":{"description":"The style of the arrow at the end of the line.","enum":["ARROW_STYLE_UNSPECIFIED","NONE","STEALTH_ARROW","FILL_ARROW","FILL_CIRCLE","FILL_SQUARE","FILL_DIAMOND","OPEN_ARROW","OPEN_CIRCLE","OPEN_SQUARE","OPEN_DIAMOND"],"type":"string"},"endConnection":{"$ref":"#/components/schemas/slides_v1_LineConnection"},"lineFill":{"$ref":"#/components/schemas/slides_v1_LineFill"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"startArrow":{"description":"The style of the arrow at the beginning of the line.","enum":["ARROW_STYLE_UNSPECIFIED","NONE","STEALTH_ARROW","FILL_ARROW","FILL_CIRCLE","FILL_SQUARE","FILL_DIAMOND","OPEN_ARROW","OPEN_CIRCLE","OPEN_SQUARE","OPEN_DIAMOND"],"type":"string"},"startConnection":{"$ref":"#/components/schemas/slides_v1_LineConnection"},"weight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_Link":{"description":"A hypertext link.","type":"object","properties":{"pageObjectId":{"description":"If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist.","type":"string"},"relativeLink":{"description":"If set, indicates this is a link to a slide in this presentation, addressed by its position.","enum":["RELATIVE_SLIDE_LINK_UNSPECIFIED","NEXT_SLIDE","PREVIOUS_SLIDE","FIRST_SLIDE","LAST_SLIDE"],"type":"string"},"slideIndex":{"description":"If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index.","format":"int32","type":"integer"},"url":{"description":"If set, indicates this is a link to the external web page at this URL.","type":"string"}}},"slides_v1_List":{"description":"A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID.","type":"object","properties":{"listId":{"description":"The ID of the list.","type":"string"},"nestingLevel":{"description":"A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive.","type":"object","additionalProperties":{"$ref":"#/components/schemas/slides_v1_NestingLevel"}}}},"slides_v1_MasterProperties":{"description":"The properties of Page that are only relevant for pages with page_type MASTER.","type":"object","properties":{"displayName":{"description":"The human-readable name of the master.","type":"string"}}},"slides_v1_MergeTableCellsRequest":{"description":"Merges cells in a Table.","type":"object","properties":{"objectId":{"description":"The object ID of the table.","type":"string"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_NestingLevel":{"description":"Contains properties describing the look and feel of a list bullet at a given level of nesting.","type":"object","properties":{"bulletStyle":{"$ref":"#/components/schemas/slides_v1_TextStyle"}}},"slides_v1_NotesProperties":{"description":"The properties of Page that are only relevant for pages with page_type NOTES.","type":"object","properties":{"speakerNotesObjectId":{"description":"The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID.","type":"string"}}},"slides_v1_ObjectAnchor":{"description":"Represents comment anchor data tied to a Slides object, for example a `Page` or PageElement. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"objectId":{"description":"Output only. The page or page element that the comment thread is anchored to.","type":"string"},"shapeTextAnchors":{"$ref":"#/components/schemas/slides_v1_ShapeTextAnchors"},"tableCellAnchors":{"$ref":"#/components/schemas/slides_v1_TableCellAnchors"}}},"slides_v1_OpaqueColor":{"description":"A themeable solid color value.","type":"object","properties":{"rgbColor":{"$ref":"#/components/schemas/slides_v1_RgbColor"},"themeColor":{"description":"An opaque theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","DARK1","LIGHT1","DARK2","LIGHT2","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","HYPERLINK","FOLLOWED_HYPERLINK","TEXT1","BACKGROUND1","TEXT2","BACKGROUND2"],"type":"string"}}},"slides_v1_OptionalColor":{"description":"A color that can either be fully opaque or fully transparent.","type":"object","properties":{"opaqueColor":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"}}},"slides_v1_Outline":{"description":"The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind.","type":"object","properties":{"dashStyle":{"description":"The dash style of the outline.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH","DASH_DOT","LONG_DASH","LONG_DASH_DOT"],"type":"string"},"outlineFill":{"$ref":"#/components/schemas/slides_v1_OutlineFill"},"propertyState":{"description":"The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"weight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_OutlineFill":{"description":"The fill of the outline.","type":"object","properties":{"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_Page":{"description":"A page in a presentation.","type":"object","properties":{"commentAnchors":{"description":"Output only. The comment anchors present on the page. [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/slides_v1_CommentAnchor"}},"comments":{"description":"Output only. The comment threads associated with the page. Only populated if the page was fetched via a GetPageRequest with a populated comments_view_mode. Otherwise, comments are returned in the Presentation via the GetPresentationRequest. [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/slides_v1_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the page. Only populated if the page was fetched via a GetPageRequest with a populated comments_view_mode. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"layoutProperties":{"$ref":"#/components/schemas/slides_v1_LayoutProperties"},"masterProperties":{"$ref":"#/components/schemas/slides_v1_MasterProperties"},"notesProperties":{"$ref":"#/components/schemas/slides_v1_NotesProperties"},"objectId":{"description":"The object ID for this page. Object IDs used by Page and PageElement share the same namespace.","type":"string"},"pageElements":{"description":"The page elements rendered on the page.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_PageElement"}},"pageProperties":{"$ref":"#/components/schemas/slides_v1_PageProperties"},"pageType":{"description":"The type of the page.","enum":["SLIDE","MASTER","LAYOUT","NOTES","NOTES_MASTER"],"type":"string"},"revisionId":{"description":"Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes.","type":"string"},"slideProperties":{"$ref":"#/components/schemas/slides_v1_SlideProperties"}}},"slides_v1_PageBackgroundFill":{"description":"The page background fill.","type":"object","properties":{"propertyState":{"description":"The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"},"stretchedPictureFill":{"$ref":"#/components/schemas/slides_v1_StretchedPictureFill"}}},"slides_v1_PageElement":{"description":"A visual element rendered on a page.","type":"object","properties":{"description":{"description":"The description of the page element. Combined with title to display alt text. The field is not supported for Group elements.","type":"string"},"elementGroup":{"$ref":"#/components/schemas/slides_v1_Group"},"image":{"$ref":"#/components/schemas/slides_v1_Image"},"line":{"$ref":"#/components/schemas/slides_v1_Line"},"objectId":{"description":"The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace.","type":"string"},"shape":{"$ref":"#/components/schemas/slides_v1_Shape"},"sheetsChart":{"$ref":"#/components/schemas/slides_v1_SheetsChart"},"size":{"$ref":"#/components/schemas/slides_v1_Size"},"speakerSpotlight":{"$ref":"#/components/schemas/slides_v1_SpeakerSpotlight"},"table":{"$ref":"#/components/schemas/slides_v1_Table"},"title":{"description":"The title of the page element. Combined with description to display alt text. The field is not supported for Group elements.","type":"string"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"},"video":{"$ref":"#/components/schemas/slides_v1_Video"},"wordArt":{"$ref":"#/components/schemas/slides_v1_WordArt"}}},"slides_v1_PageElementProperties":{"description":"Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both `size` and `transform`, but the visual size will be unchanged.","type":"object","properties":{"pageObjectId":{"description":"The object ID of the page where the element is located.","type":"string"},"size":{"$ref":"#/components/schemas/slides_v1_Size"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"}}},"slides_v1_PageProperties":{"description":"The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties.","type":"object","properties":{"colorScheme":{"$ref":"#/components/schemas/slides_v1_ColorScheme"},"pageBackgroundFill":{"$ref":"#/components/schemas/slides_v1_PageBackgroundFill"}}},"slides_v1_ParagraphMarker":{"description":"A TextElement kind that represents the beginning of a new paragraph.","type":"object","properties":{"bullet":{"$ref":"#/components/schemas/slides_v1_Bullet"},"style":{"$ref":"#/components/schemas/slides_v1_ParagraphStyle"}}},"slides_v1_ParagraphStyle":{"description":"Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message.","type":"object","properties":{"alignment":{"description":"The text alignment for this paragraph.","enum":["ALIGNMENT_UNSPECIFIED","START","CENTER","END","JUSTIFIED"],"type":"string"},"direction":{"description":"The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited.","enum":["TEXT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"indentEnd":{"$ref":"#/components/schemas/slides_v1_Dimension"},"indentFirstLine":{"$ref":"#/components/schemas/slides_v1_Dimension"},"indentStart":{"$ref":"#/components/schemas/slides_v1_Dimension"},"lineSpacing":{"description":"The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.","format":"float","type":"number"},"spaceAbove":{"$ref":"#/components/schemas/slides_v1_Dimension"},"spaceBelow":{"$ref":"#/components/schemas/slides_v1_Dimension"},"spacingMode":{"description":"The spacing mode for the paragraph.","enum":["SPACING_MODE_UNSPECIFIED","NEVER_COLLAPSE","COLLAPSE_LISTS"],"type":"string"}}},"slides_v1_Placeholder":{"description":"The placeholder information that uniquely identifies a placeholder shape.","type":"object","properties":{"index":{"description":"The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values.","format":"int32","type":"integer"},"parentObjectId":{"description":"The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape.","type":"string"},"type":{"description":"The type of the placeholder.","enum":["NONE","BODY","CHART","CLIP_ART","CENTERED_TITLE","DIAGRAM","DATE_AND_TIME","FOOTER","HEADER","MEDIA","OBJECT","PICTURE","SLIDE_NUMBER","SUBTITLE","TABLE","TITLE","SLIDE_IMAGE"],"type":"string"}}},"slides_v1_Post":{"description":"Represents a single post in a comment thread. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"assigneeEmail":{"description":"Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assignee_email` exceeds 2048 UTF-8 code units.","type":"string"},"author":{"$ref":"#/components/schemas/slides_v1_PostAuthor"},"commentAction":{"description":"Action taken as part of creating the post.","enum":["COMMENT_ACTION_TYPE_UNSPECIFIED","NO_COMMENT_ACTION_CHANGE","RESOLVE","REOPEN"],"type":"string"},"content":{"description":"The content of the post. Required to be non-empty if comment_action is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Slides editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.","type":"string"},"contentHtml":{"description":"Output only. The content of the post as HTML.","type":"string"},"createTime":{"description":"Output only. The time the post was created.","format":"google-datetime","type":"string"},"deleted":{"description":"Output only. Whether the post is deleted. If `true`, content and author fields will be empty.","type":"boolean"},"fromCopiedPresentation":{"description":"Output only. Whether the post is from a copied presentation. This field cannot be set directly by callers.","type":"boolean"},"fromImportedPresentation":{"description":"Output only. Whether the post is from an imported presentation. This field cannot be set directly by callers.","type":"boolean"},"postId":{"description":"Output only. The unique ID of the post.","type":"string"},"updateTime":{"description":"Output only. The time the post was last updated.","format":"google-datetime","type":"string"}}},"slides_v1_PostAuthor":{"description":"Represents a user who authored a comment post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"anonymous":{"description":"Whether the user is anonymous.","type":"boolean"},"displayName":{"description":"The display name of the user. May be absent if the author is anonymous.","type":"string"},"me":{"description":"Whether the user is the authenticated user making the request.","type":"boolean"},"user":{"description":"The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported presentation.","type":"string"}}},"slides_v1_Presentation":{"description":"A Google Slides presentation.","type":"object","properties":{"comments":{"description":"Output only. The comment threads associated with the presentation. [Developer Preview](https://developers.google.com/workspace/preview).","type":"array","items":{"$ref":"#/components/schemas/slides_v1_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the presentation. [Developer Preview](https://developers.google.com/workspace/preview).","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"layouts":{"description":"The layouts in the presentation. A layout is a template that determines how content is arranged and styled on the slides that inherit from that layout.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Page"}},"locale":{"description":"The locale of the presentation, as an IETF BCP 47 language tag.","type":"string"},"masters":{"description":"The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts. They serve three purposes: - Placeholder shapes on a master contain the default text styles and shape properties of all placeholder shapes on pages that use that master. - The master page properties define the common page properties inherited by its layouts. - Any other shapes on the master slide appear on all slides using that master, regardless of their layout.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Page"}},"notesMaster":{"$ref":"#/components/schemas/slides_v1_Page"},"pageSize":{"$ref":"#/components/schemas/slides_v1_Size"},"presentationId":{"description":"The ID of the presentation.","type":"string"},"revisionId":{"description":"Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but a nebulous string. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes.","type":"string"},"slides":{"description":"The slides in the presentation. A slide inherits properties from a slide layout.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Page"}},"title":{"description":"The title of the presentation.","type":"string"}}},"slides_v1_Range":{"description":"Specifies a contiguous range of an indexed collection, such as characters in text.","type":"object","properties":{"endIndex":{"description":"The optional zero-based index of the end of the collection. Required for `FIXED_RANGE` ranges.","format":"int32","type":"integer"},"startIndex":{"description":"The optional zero-based index of the beginning of the collection. Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges.","format":"int32","type":"integer"},"type":{"description":"The type of range.","enum":["RANGE_TYPE_UNSPECIFIED","FIXED_RANGE","FROM_START_INDEX","ALL"],"type":"string"}}},"slides_v1_Recolor":{"description":"A recolor effect applied on an image.","type":"object","properties":{"name":{"description":"The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only.","enum":["NONE","LIGHT1","LIGHT2","LIGHT3","LIGHT4","LIGHT5","LIGHT6","LIGHT7","LIGHT8","LIGHT9","LIGHT10","DARK1","DARK2","DARK3","DARK4","DARK5","DARK6","DARK7","DARK8","DARK9","DARK10","GRAYSCALE","NEGATIVE","SEPIA","CUSTOM"],"type":"string"},"recolorStops":{"description":"The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_ColorStop"}}}},"slides_v1_RefreshSheetsChartRequest":{"description":"Refreshes an embedded Google Sheets chart by replacing it with the latest version of the chart from Google Sheets. NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.","type":"object","properties":{"objectId":{"description":"The object ID of the chart to refresh.","type":"string"}}},"slides_v1_ReplaceAllShapesWithImageRequest":{"description":"Replaces all shapes that match the given criteria with the provided image. The images replacing the shapes are rectangular after being inserted into the presentation and do not take on the forms of the shapes.","type":"object","properties":{"containsText":{"$ref":"#/components/schemas/slides_v1_SubstringMatchCriteria"},"imageReplaceMethod":{"description":"The image replace method. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence. If you do not specify a value for `image_replace_method`, but specify a value for `replace_method`, then the specified `replace_method` value is used. If you do not specify either, then CENTER_INSIDE is used.","enum":["IMAGE_REPLACE_METHOD_UNSPECIFIED","CENTER_INSIDE","CENTER_CROP"],"type":"string"},"imageUrl":{"description":"The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field.","type":"string"},"pageObjectIds":{"description":"If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation.","type":"array","items":{"type":"string"}},"replaceMethod":{"description":"The replace method. *Deprecated*: use `image_replace_method` instead. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence.","enum":["CENTER_INSIDE","CENTER_CROP"],"type":"string"}}},"slides_v1_ReplaceAllShapesWithImageResponse":{"description":"The result of replacing shapes with an image.","type":"object","properties":{"occurrencesChanged":{"description":"The number of shapes replaced with images.","format":"int32","type":"integer"}}},"slides_v1_ReplaceAllShapesWithSheetsChartRequest":{"description":"Replaces all shapes that match the given criteria with the provided Google Sheets chart. The chart will be scaled and centered to fit within the bounds of the original shape. NOTE: Replacing shapes with a chart requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet.","format":"int32","type":"integer"},"containsText":{"$ref":"#/components/schemas/slides_v1_SubstringMatchCriteria"},"linkingMode":{"description":"The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked.","enum":["NOT_LINKED_IMAGE","LINKED"],"type":"string"},"pageObjectIds":{"description":"If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation.","type":"array","items":{"type":"string"}},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the chart.","type":"string"}}},"slides_v1_ReplaceAllShapesWithSheetsChartResponse":{"description":"The result of replacing shapes with a Google Sheets chart.","type":"object","properties":{"occurrencesChanged":{"description":"The number of shapes replaced with charts.","format":"int32","type":"integer"}}},"slides_v1_ReplaceAllTextRequest":{"description":"Replaces all instances of text matching a criteria with replace text.","type":"object","properties":{"containsText":{"$ref":"#/components/schemas/slides_v1_SubstringMatchCriteria"},"pageObjectIds":{"description":"If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes master, or if a page with that object ID doesn't exist in the presentation.","type":"array","items":{"type":"string"}},"replaceText":{"description":"The text that will replace the matched text.","type":"string"}}},"slides_v1_ReplaceAllTextResponse":{"description":"The result of replacing text.","type":"object","properties":{"occurrencesChanged":{"description":"The number of occurrences changed by replacing all text.","format":"int32","type":"integer"}}},"slides_v1_ReplaceImageRequest":{"description":"Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image.","type":"object","properties":{"imageObjectId":{"description":"The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.","type":"string"},"imageReplaceMethod":{"description":"The replacement method.","enum":["IMAGE_REPLACE_METHOD_UNSPECIFIED","CENTER_INSIDE","CENTER_CROP"],"type":"string"},"url":{"description":"The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URL can't surpass 2 KB in length. The URL is saved with the image, and exposed through the Image.source_url field.","type":"string"}}},"slides_v1_Request":{"description":"A single kind of update to apply to a presentation.","type":"object","properties":{"addCommentReply":{"$ref":"#/components/schemas/slides_v1_AddCommentReplyRequest"},"createImage":{"$ref":"#/components/schemas/slides_v1_CreateImageRequest"},"createLine":{"$ref":"#/components/schemas/slides_v1_CreateLineRequest"},"createParagraphBullets":{"$ref":"#/components/schemas/slides_v1_CreateParagraphBulletsRequest"},"createShape":{"$ref":"#/components/schemas/slides_v1_CreateShapeRequest"},"createSheetsChart":{"$ref":"#/components/schemas/slides_v1_CreateSheetsChartRequest"},"createSlide":{"$ref":"#/components/schemas/slides_v1_CreateSlideRequest"},"createTable":{"$ref":"#/components/schemas/slides_v1_CreateTableRequest"},"createVideo":{"$ref":"#/components/schemas/slides_v1_CreateVideoRequest"},"deleteComment":{"$ref":"#/components/schemas/slides_v1_DeleteCommentRequest"},"deleteCommentReply":{"$ref":"#/components/schemas/slides_v1_DeleteCommentReplyRequest"},"deleteObject":{"$ref":"#/components/schemas/slides_v1_DeleteObjectRequest"},"deleteParagraphBullets":{"$ref":"#/components/schemas/slides_v1_DeleteParagraphBulletsRequest"},"deleteTableColumn":{"$ref":"#/components/schemas/slides_v1_DeleteTableColumnRequest"},"deleteTableRow":{"$ref":"#/components/schemas/slides_v1_DeleteTableRowRequest"},"deleteText":{"$ref":"#/components/schemas/slides_v1_DeleteTextRequest"},"duplicateObject":{"$ref":"#/components/schemas/slides_v1_DuplicateObjectRequest"},"groupObjects":{"$ref":"#/components/schemas/slides_v1_GroupObjectsRequest"},"insertComment":{"$ref":"#/components/schemas/slides_v1_InsertCommentRequest"},"insertTableColumns":{"$ref":"#/components/schemas/slides_v1_InsertTableColumnsRequest"},"insertTableRows":{"$ref":"#/components/schemas/slides_v1_InsertTableRowsRequest"},"insertText":{"$ref":"#/components/schemas/slides_v1_InsertTextRequest"},"mergeTableCells":{"$ref":"#/components/schemas/slides_v1_MergeTableCellsRequest"},"refreshSheetsChart":{"$ref":"#/components/schemas/slides_v1_RefreshSheetsChartRequest"},"replaceAllShapesWithImage":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithImageRequest"},"replaceAllShapesWithSheetsChart":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithSheetsChartRequest"},"replaceAllText":{"$ref":"#/components/schemas/slides_v1_ReplaceAllTextRequest"},"replaceImage":{"$ref":"#/components/schemas/slides_v1_ReplaceImageRequest"},"rerouteLine":{"$ref":"#/components/schemas/slides_v1_RerouteLineRequest"},"ungroupObjects":{"$ref":"#/components/schemas/slides_v1_UngroupObjectsRequest"},"unmergeTableCells":{"$ref":"#/components/schemas/slides_v1_UnmergeTableCellsRequest"},"updateCommentPost":{"$ref":"#/components/schemas/slides_v1_UpdateCommentPostRequest"},"updateImageProperties":{"$ref":"#/components/schemas/slides_v1_UpdateImagePropertiesRequest"},"updateLineCategory":{"$ref":"#/components/schemas/slides_v1_UpdateLineCategoryRequest"},"updateLineProperties":{"$ref":"#/components/schemas/slides_v1_UpdateLinePropertiesRequest"},"updatePageElementAltText":{"$ref":"#/components/schemas/slides_v1_UpdatePageElementAltTextRequest"},"updatePageElementTransform":{"$ref":"#/components/schemas/slides_v1_UpdatePageElementTransformRequest"},"updatePageElementsZOrder":{"$ref":"#/components/schemas/slides_v1_UpdatePageElementsZOrderRequest"},"updatePageProperties":{"$ref":"#/components/schemas/slides_v1_UpdatePagePropertiesRequest"},"updateParagraphStyle":{"$ref":"#/components/schemas/slides_v1_UpdateParagraphStyleRequest"},"updateShapeProperties":{"$ref":"#/components/schemas/slides_v1_UpdateShapePropertiesRequest"},"updateSlideProperties":{"$ref":"#/components/schemas/slides_v1_UpdateSlidePropertiesRequest"},"updateSlidesPosition":{"$ref":"#/components/schemas/slides_v1_UpdateSlidesPositionRequest"},"updateTableBorderProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableBorderPropertiesRequest"},"updateTableCellProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableCellPropertiesRequest"},"updateTableColumnProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableColumnPropertiesRequest"},"updateTableRowProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableRowPropertiesRequest"},"updateTextStyle":{"$ref":"#/components/schemas/slides_v1_UpdateTextStyleRequest"},"updateVideoProperties":{"$ref":"#/components/schemas/slides_v1_UpdateVideoPropertiesRequest"}}},"slides_v1_RerouteLineRequest":{"description":"Reroutes a line such that it's connected at the two closest connection sites on the connected page elements.","type":"object","properties":{"objectId":{"description":"The object ID of the line to reroute. Only a line with a category indicating it is a \"connector\" can be rerouted. The start and end connections of the line must be on different page elements.","type":"string"}}},"slides_v1_Response":{"description":"A single response from an update.","type":"object","properties":{"addCommentReply":{"$ref":"#/components/schemas/slides_v1_AddCommentReplyResponse"},"createImage":{"$ref":"#/components/schemas/slides_v1_CreateImageResponse"},"createLine":{"$ref":"#/components/schemas/slides_v1_CreateLineResponse"},"createShape":{"$ref":"#/components/schemas/slides_v1_CreateShapeResponse"},"createSheetsChart":{"$ref":"#/components/schemas/slides_v1_CreateSheetsChartResponse"},"createSlide":{"$ref":"#/components/schemas/slides_v1_CreateSlideResponse"},"createTable":{"$ref":"#/components/schemas/slides_v1_CreateTableResponse"},"createVideo":{"$ref":"#/components/schemas/slides_v1_CreateVideoResponse"},"duplicateObject":{"$ref":"#/components/schemas/slides_v1_DuplicateObjectResponse"},"groupObjects":{"$ref":"#/components/schemas/slides_v1_GroupObjectsResponse"},"insertComment":{"$ref":"#/components/schemas/slides_v1_InsertCommentResponse"},"replaceAllShapesWithImage":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithImageResponse"},"replaceAllShapesWithSheetsChart":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithSheetsChartResponse"},"replaceAllText":{"$ref":"#/components/schemas/slides_v1_ReplaceAllTextResponse"}}},"slides_v1_RgbColor":{"description":"An RGB color.","type":"object","properties":{"blue":{"description":"The blue component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"green":{"description":"The green component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"red":{"description":"The red component of the color, from 0.0 to 1.0.","format":"float","type":"number"}}},"slides_v1_Shadow":{"description":"The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind.","type":"object","properties":{"alignment":{"description":"The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only.","enum":["RECTANGLE_POSITION_UNSPECIFIED","TOP_LEFT","TOP_CENTER","TOP_RIGHT","LEFT_CENTER","CENTER","RIGHT_CENTER","BOTTOM_LEFT","BOTTOM_CENTER","BOTTOM_RIGHT"],"type":"string"},"alpha":{"description":"The alpha of the shadow's color, from 0.0 to 1.0.","format":"float","type":"number"},"blurRadius":{"$ref":"#/components/schemas/slides_v1_Dimension"},"color":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"},"propertyState":{"description":"The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"rotateWithShape":{"description":"Whether the shadow should rotate with the shape. This property is read-only.","type":"boolean"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"},"type":{"description":"The type of the shadow. This property is read-only.","enum":["SHADOW_TYPE_UNSPECIFIED","OUTER"],"type":"string"}}},"slides_v1_Shape":{"description":"A PageElement kind representing a generic shape that doesn't have a more specific classification. For more information, see [Size and position page elements](https://developers.google.com/workspace/slides/api/guides/transform).","type":"object","properties":{"placeholder":{"$ref":"#/components/schemas/slides_v1_Placeholder"},"shapeProperties":{"$ref":"#/components/schemas/slides_v1_ShapeProperties"},"shapeType":{"description":"The type of the shape.","enum":["TYPE_UNSPECIFIED","TEXT_BOX","RECTANGLE","ROUND_RECTANGLE","ELLIPSE","ARC","BENT_ARROW","BENT_UP_ARROW","BEVEL","BLOCK_ARC","BRACE_PAIR","BRACKET_PAIR","CAN","CHEVRON","CHORD","CLOUD","CORNER","CUBE","CURVED_DOWN_ARROW","CURVED_LEFT_ARROW","CURVED_RIGHT_ARROW","CURVED_UP_ARROW","DECAGON","DIAGONAL_STRIPE","DIAMOND","DODECAGON","DONUT","DOUBLE_WAVE","DOWN_ARROW","DOWN_ARROW_CALLOUT","FOLDED_CORNER","FRAME","HALF_FRAME","HEART","HEPTAGON","HEXAGON","HOME_PLATE","HORIZONTAL_SCROLL","IRREGULAR_SEAL_1","IRREGULAR_SEAL_2","LEFT_ARROW","LEFT_ARROW_CALLOUT","LEFT_BRACE","LEFT_BRACKET","LEFT_RIGHT_ARROW","LEFT_RIGHT_ARROW_CALLOUT","LEFT_RIGHT_UP_ARROW","LEFT_UP_ARROW","LIGHTNING_BOLT","MATH_DIVIDE","MATH_EQUAL","MATH_MINUS","MATH_MULTIPLY","MATH_NOT_EQUAL","MATH_PLUS","MOON","NO_SMOKING","NOTCHED_RIGHT_ARROW","OCTAGON","PARALLELOGRAM","PENTAGON","PIE","PLAQUE","PLUS","QUAD_ARROW","QUAD_ARROW_CALLOUT","RIBBON","RIBBON_2","RIGHT_ARROW","RIGHT_ARROW_CALLOUT","RIGHT_BRACE","RIGHT_BRACKET","ROUND_1_RECTANGLE","ROUND_2_DIAGONAL_RECTANGLE","ROUND_2_SAME_RECTANGLE","RIGHT_TRIANGLE","SMILEY_FACE","SNIP_1_RECTANGLE","SNIP_2_DIAGONAL_RECTANGLE","SNIP_2_SAME_RECTANGLE","SNIP_ROUND_RECTANGLE","STAR_10","STAR_12","STAR_16","STAR_24","STAR_32","STAR_4","STAR_5","STAR_6","STAR_7","STAR_8","STRIPED_RIGHT_ARROW","SUN","TRAPEZOID","TRIANGLE","UP_ARROW","UP_ARROW_CALLOUT","UP_DOWN_ARROW","UTURN_ARROW","VERTICAL_SCROLL","WAVE","WEDGE_ELLIPSE_CALLOUT","WEDGE_RECTANGLE_CALLOUT","WEDGE_ROUND_RECTANGLE_CALLOUT","FLOW_CHART_ALTERNATE_PROCESS","FLOW_CHART_COLLATE","FLOW_CHART_CONNECTOR","FLOW_CHART_DECISION","FLOW_CHART_DELAY","FLOW_CHART_DISPLAY","FLOW_CHART_DOCUMENT","FLOW_CHART_EXTRACT","FLOW_CHART_INPUT_OUTPUT","FLOW_CHART_INTERNAL_STORAGE","FLOW_CHART_MAGNETIC_DISK","FLOW_CHART_MAGNETIC_DRUM","FLOW_CHART_MAGNETIC_TAPE","FLOW_CHART_MANUAL_INPUT","FLOW_CHART_MANUAL_OPERATION","FLOW_CHART_MERGE","FLOW_CHART_MULTIDOCUMENT","FLOW_CHART_OFFLINE_STORAGE","FLOW_CHART_OFFPAGE_CONNECTOR","FLOW_CHART_ONLINE_STORAGE","FLOW_CHART_OR","FLOW_CHART_PREDEFINED_PROCESS","FLOW_CHART_PREPARATION","FLOW_CHART_PROCESS","FLOW_CHART_PUNCHED_CARD","FLOW_CHART_PUNCHED_TAPE","FLOW_CHART_SORT","FLOW_CHART_SUMMING_JUNCTION","FLOW_CHART_TERMINATOR","ARROW_EAST","ARROW_NORTH_EAST","ARROW_NORTH","SPEECH","STARBURST","TEARDROP","ELLIPSE_RIBBON","ELLIPSE_RIBBON_2","CLOUD_CALLOUT","CUSTOM"],"type":"string"},"text":{"$ref":"#/components/schemas/slides_v1_TextContent"}}},"slides_v1_ShapeBackgroundFill":{"description":"The shape background fill.","type":"object","properties":{"propertyState":{"description":"The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_ShapeProperties":{"description":"The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape.","type":"object","properties":{"autofit":{"$ref":"#/components/schemas/slides_v1_Autofit"},"contentAlignment":{"description":"The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor.","enum":["CONTENT_ALIGNMENT_UNSPECIFIED","CONTENT_ALIGNMENT_UNSUPPORTED","TOP","MIDDLE","BOTTOM"],"type":"string"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"shadow":{"$ref":"#/components/schemas/slides_v1_Shadow"},"shapeBackgroundFill":{"$ref":"#/components/schemas/slides_v1_ShapeBackgroundFill"}}},"slides_v1_ShapeTextAnchor":{"description":"An anchor to a specific range of text within a Shape's text. [Developer Preview](https://developers.google.com/workspace/preview). To insert comments in speaker notes, use the ShapeTextAnchor with the speaker notes object ID.","type":"object","properties":{"objectId":{"description":"The object ID of the page element containing the text.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_ShapeTextAnchors":{"description":"Represents text ranges within a shape covered by a comment anchor. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"ranges":{"description":"A list of text ranges covered by the comment anchor.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TextRange"}}}},"slides_v1_SheetsChart":{"description":"A PageElement kind representing a linked chart embedded from Google Sheets.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet that is embedded.","format":"int32","type":"integer"},"contentUrl":{"description":"The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change.","type":"string"},"sheetsChartProperties":{"$ref":"#/components/schemas/slides_v1_SheetsChartProperties"},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the source chart.","type":"string"}}},"slides_v1_SheetsChartProperties":{"description":"The properties of the SheetsChart.","type":"object","properties":{"chartImageProperties":{"$ref":"#/components/schemas/slides_v1_ImageProperties"}}},"slides_v1_Size":{"description":"A width and height.","type":"object","properties":{"height":{"$ref":"#/components/schemas/slides_v1_Dimension"},"width":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_SlideProperties":{"description":"The properties of Page that are only relevant for pages with page_type SLIDE.","type":"object","properties":{"isSkipped":{"description":"Whether the slide is skipped in the presentation mode. Defaults to false.","type":"boolean"},"layoutObjectId":{"description":"The object ID of the layout that this slide is based on. This property is read-only.","type":"string"},"masterObjectId":{"description":"The object ID of the master that this slide is based on. This property is read-only.","type":"string"},"notesPage":{"$ref":"#/components/schemas/slides_v1_Page"}}},"slides_v1_SolidFill":{"description":"A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists.","type":"object","properties":{"alpha":{"description":"The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color.","format":"float","type":"number"},"color":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"}}},"slides_v1_SpeakerSpotlight":{"description":"A PageElement kind representing a Speaker Spotlight.","type":"object","properties":{"speakerSpotlightProperties":{"$ref":"#/components/schemas/slides_v1_SpeakerSpotlightProperties"}}},"slides_v1_SpeakerSpotlightProperties":{"description":"The properties of the SpeakerSpotlight.","type":"object","properties":{"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"shadow":{"$ref":"#/components/schemas/slides_v1_Shadow"}}},"slides_v1_StretchedPictureFill":{"description":"The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.","type":"object","properties":{"contentUrl":{"description":"Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length.","type":"string"},"size":{"$ref":"#/components/schemas/slides_v1_Size"}}},"slides_v1_SubstringMatchCriteria":{"description":"A criteria that matches a specific string of text in a shape or table.","type":"object","properties":{"matchCase":{"description":"Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive.","type":"boolean"},"searchByRegex":{"description":"Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching.","type":"boolean"},"text":{"description":"The text to search for in the shape or table.","type":"string"}}},"slides_v1_Table":{"description":"A PageElement kind representing a table.","type":"object","properties":{"columns":{"description":"Number of columns in the table.","format":"int32","type":"integer"},"horizontalBorderRows":{"description":"Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableBorderRow"}},"rows":{"description":"Number of rows in the table.","format":"int32","type":"integer"},"tableColumns":{"description":"Properties of each column.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableColumnProperties"}},"tableRows":{"description":"Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableRow"}},"verticalBorderRows":{"description":"Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableBorderRow"}}}},"slides_v1_TableAnchor":{"description":"An anchor to a specific range of cells within a Table. Used to anchor a comment to all of the text in each cell in a range within a table. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"objectId":{"description":"The object ID of the table.","type":"string"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_TableBorderCell":{"description":"The properties of each border cell.","type":"object","properties":{"location":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"tableBorderProperties":{"$ref":"#/components/schemas/slides_v1_TableBorderProperties"}}},"slides_v1_TableBorderFill":{"description":"The fill of the border.","type":"object","properties":{"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_TableBorderProperties":{"description":"The border styling properties of the TableBorderCell.","type":"object","properties":{"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH","DASH_DOT","LONG_DASH","LONG_DASH_DOT"],"type":"string"},"tableBorderFill":{"$ref":"#/components/schemas/slides_v1_TableBorderFill"},"weight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_TableBorderRow":{"description":"Contents of each border row in a table.","type":"object","properties":{"tableBorderCells":{"description":"Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableBorderCell"}}}},"slides_v1_TableCell":{"description":"Properties and contents of each table cell.","type":"object","properties":{"columnSpan":{"description":"Column span of the cell.","format":"int32","type":"integer"},"location":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"rowSpan":{"description":"Row span of the cell.","format":"int32","type":"integer"},"tableCellProperties":{"$ref":"#/components/schemas/slides_v1_TableCellProperties"},"text":{"$ref":"#/components/schemas/slides_v1_TextContent"}}},"slides_v1_TableCellAnchors":{"description":"Represents table cell ranges within a table covered by a comment anchor. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"cellRanges":{"description":"A list of all table cells in a table that have text covered by the anchor in the table.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableCellTextRanges"}}}},"slides_v1_TableCellBackgroundFill":{"description":"The table cell background fill.","type":"object","properties":{"propertyState":{"description":"The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_TableCellLocation":{"description":"A location of a single table cell within a table.","type":"object","properties":{"columnIndex":{"description":"The 0-based column index.","format":"int32","type":"integer"},"rowIndex":{"description":"The 0-based row index.","format":"int32","type":"integer"}}},"slides_v1_TableCellProperties":{"description":"The properties of the TableCell.","type":"object","properties":{"contentAlignment":{"description":"The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor.","enum":["CONTENT_ALIGNMENT_UNSPECIFIED","CONTENT_ALIGNMENT_UNSUPPORTED","TOP","MIDDLE","BOTTOM"],"type":"string"},"tableCellBackgroundFill":{"$ref":"#/components/schemas/slides_v1_TableCellBackgroundFill"}}},"slides_v1_TableCellTextAnchor":{"description":"An anchor to a specific range of text within a TableCell's TextElement. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the table containing the cell.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_TableCellTextRanges":{"description":"Represents text ranges within a table cell covered by a comment anchor. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"ranges":{"description":"A list of all text ranges covered by the anchor in this cell.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TextRange"}}}},"slides_v1_TableColumnProperties":{"description":"Properties of each column in a table.","type":"object","properties":{"columnWidth":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_TableRange":{"description":"A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]","type":"object","properties":{"columnSpan":{"description":"The column span of the table range.","format":"int32","type":"integer"},"location":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"rowSpan":{"description":"The row span of the table range.","format":"int32","type":"integer"}}},"slides_v1_TableRow":{"description":"Properties and contents of each row in a table.","type":"object","properties":{"rowHeight":{"$ref":"#/components/schemas/slides_v1_Dimension"},"tableCells":{"description":"Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableCell"}},"tableRowProperties":{"$ref":"#/components/schemas/slides_v1_TableRowProperties"}}},"slides_v1_TableRowProperties":{"description":"Properties of each row in a table.","type":"object","properties":{"minRowHeight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_TextContent":{"description":"The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page.","type":"object","properties":{"lists":{"description":"The bulleted lists contained in this text, keyed by list ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/slides_v1_List"}},"textElements":{"description":"The text contents broken down into its component parts, including styling information. This property is read-only.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TextElement"}}}},"slides_v1_TextElement":{"description":"A TextElement describes the content of a range of indices in the text content of a Shape or TableCell.","type":"object","properties":{"autoText":{"$ref":"#/components/schemas/slides_v1_AutoText"},"endIndex":{"description":"The zero-based end index of this text element, exclusive, in Unicode code units.","format":"int32","type":"integer"},"paragraphMarker":{"$ref":"#/components/schemas/slides_v1_ParagraphMarker"},"startIndex":{"description":"The zero-based start index of this text element, in Unicode code units.","format":"int32","type":"integer"},"textRun":{"$ref":"#/components/schemas/slides_v1_TextRun"}}},"slides_v1_TextRange":{"description":"Specifies a contiguous range of text within a shape or table cell's text. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"endIndex":{"description":"The zero-based index of the end of the range. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"},"startIndex":{"description":"The zero-based index of the beginning range. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"}}},"slides_v1_TextRun":{"description":"A TextElement kind that represents a run of text that all has the same styling.","type":"object","properties":{"content":{"description":"The text of this run.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_TextStyle"}}},"slides_v1_TextStyle":{"description":"Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/slides_v1_OptionalColor"},"baselineOffset":{"description":"The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field.","enum":["BASELINE_OFFSET_UNSPECIFIED","NONE","SUPERSCRIPT","SUBSCRIPT"],"type":"string"},"bold":{"description":"Whether or not the text is rendered as bold.","type":"boolean"},"fontFamily":{"description":"The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used.","type":"string"},"fontSize":{"$ref":"#/components/schemas/slides_v1_Dimension"},"foregroundColor":{"$ref":"#/components/schemas/slides_v1_OptionalColor"},"italic":{"description":"Whether or not the text is italicized.","type":"boolean"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"smallCaps":{"description":"Whether or not the text is in small capital letters.","type":"boolean"},"strikethrough":{"description":"Whether or not the text is struck through.","type":"boolean"},"underline":{"description":"Whether or not the text is underlined.","type":"boolean"},"weightedFontFamily":{"$ref":"#/components/schemas/slides_v1_WeightedFontFamily"}}},"slides_v1_ThemeColorPair":{"description":"A pair mapping a theme color type to the concrete color it represents.","type":"object","properties":{"color":{"$ref":"#/components/schemas/slides_v1_RgbColor"},"type":{"description":"The type of the theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","DARK1","LIGHT1","DARK2","LIGHT2","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","HYPERLINK","FOLLOWED_HYPERLINK","TEXT1","BACKGROUND1","TEXT2","BACKGROUND2"],"type":"string"}}},"slides_v1_Thumbnail":{"description":"The thumbnail of a page.","type":"object","properties":{"contentUrl":{"description":"The content URL of the thumbnail image. The URL to the image has a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. The mime type of the thumbnail image is the same as specified in the `GetPageThumbnailRequest`.","type":"string"},"height":{"description":"The positive height in pixels of the thumbnail image.","format":"int32","type":"integer"},"width":{"description":"The positive width in pixels of the thumbnail image.","format":"int32","type":"integer"}}},"slides_v1_UngroupObjectsRequest":{"description":"Ungroups objects, such as groups.","type":"object","properties":{"objectIds":{"description":"The object IDs of the objects to ungroup. Only groups that are not inside other groups can be ungrouped. All the groups should be on the same page. The group itself is deleted. The visual sizes and positions of all the children are preserved.","type":"array","items":{"type":"string"}}}},"slides_v1_UnmergeTableCellsRequest":{"description":"Unmerges cells in a Table.","type":"object","properties":{"objectId":{"description":"The object ID of the table.","type":"string"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_UpdateCommentPostRequest":{"description":"Updates a Post in a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. [Developer Preview](https://developers.google.com/workspace/preview).","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"content":{"description":"The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Slides editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"postId":{"description":"The ID of the post being updated.","type":"string"}}},"slides_v1_UpdateImagePropertiesRequest":{"description":"Update the properties of an Image.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `imageProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the image outline color, set `fields` to `\"outline.outlineFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"imageProperties":{"$ref":"#/components/schemas/slides_v1_ImageProperties"},"objectId":{"description":"The object ID of the image the updates are applied to.","type":"string"}}},"slides_v1_UpdateLineCategoryRequest":{"description":"Updates the category of a line.","type":"object","properties":{"lineCategory":{"description":"The line category to update to. The exact line type is determined based on the category to update to and how it's routed to connect to other page elements.","enum":["LINE_CATEGORY_UNSPECIFIED","STRAIGHT","BENT","CURVED"],"type":"string"},"objectId":{"description":"The object ID of the line the update is applied to. Only a line with a category indicating it is a \"connector\" can be updated. The line may be rerouted after updating its category.","type":"string"}}},"slides_v1_UpdateLinePropertiesRequest":{"description":"Updates the properties of a Line.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `lineProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the line solid fill color, set `fields` to `\"lineFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"lineProperties":{"$ref":"#/components/schemas/slides_v1_LineProperties"},"objectId":{"description":"The object ID of the line the update is applied to.","type":"string"}}},"slides_v1_UpdatePageElementAltTextRequest":{"description":"Updates the alt text title and/or description of a page element.","type":"object","properties":{"description":{"description":"The updated alt text description of the page element. If unset the existing value will be maintained. The description is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.","type":"string"},"objectId":{"description":"The object ID of the page element the updates are applied to.","type":"string"},"title":{"description":"The updated alt text title of the page element. If unset the existing value will be maintained. The title is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.","type":"string"}}},"slides_v1_UpdatePageElementTransformRequest":{"description":"Updates the transform of a page element. Updating the transform of a group will change the absolute transform of the page elements in that group, which can change their visual appearance. See the documentation for PageElement.transform for more details.","type":"object","properties":{"applyMode":{"description":"The apply mode of the transform update.","enum":["APPLY_MODE_UNSPECIFIED","RELATIVE","ABSOLUTE"],"type":"string"},"objectId":{"description":"The object ID of the page element to update.","type":"string"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"}}},"slides_v1_UpdatePageElementsZOrderRequest":{"description":"Updates the Z-order of page elements. Z-order is an ordering of the elements on the page from back to front. The page element in the front may cover the elements that are behind it.","type":"object","properties":{"operation":{"description":"The Z-order operation to apply on the page elements. When applying the operation on multiple page elements, the relative Z-orders within these page elements before the operation is maintained.","enum":["Z_ORDER_OPERATION_UNSPECIFIED","BRING_TO_FRONT","BRING_FORWARD","SEND_BACKWARD","SEND_TO_BACK"],"type":"string"},"pageElementObjectIds":{"description":"The object IDs of the page elements to update. All the page elements must be on the same page and must not be grouped.","type":"array","items":{"type":"string"}}}},"slides_v1_UpdatePagePropertiesRequest":{"description":"Updates the properties of a Page.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `pageProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the page background solid fill color, set `fields` to `\"pageBackgroundFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the page the update is applied to.","type":"string"},"pageProperties":{"$ref":"#/components/schemas/slides_v1_PageProperties"}}},"slides_v1_UpdateParagraphStyleRequest":{"description":"Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the paragraph alignment, set `fields` to `\"alignment\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the shape or table with the text to be styled.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_ParagraphStyle"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_UpdateShapePropertiesRequest":{"description":"Update the properties of a Shape.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `shapeProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the shape background solid fill color, set `fields` to `\"shapeBackgroundFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the shape the updates are applied to.","type":"string"},"shapeProperties":{"$ref":"#/components/schemas/slides_v1_ShapeProperties"}}},"slides_v1_UpdateSlidePropertiesRequest":{"description":"Updates the properties of a Slide.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root 'slideProperties' is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update whether a slide is skipped, set `fields` to `\"isSkipped\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the slide the update is applied to.","type":"string"},"slideProperties":{"$ref":"#/components/schemas/slides_v1_SlideProperties"}}},"slides_v1_UpdateSlidesPositionRequest":{"description":"Updates the position of slides in the presentation.","type":"object","properties":{"insertionIndex":{"description":"The index where the slides should be inserted, based on the slide arrangement before the move takes place. Must be between zero and the number of slides in the presentation, inclusive.","format":"int32","type":"integer"},"slideObjectIds":{"description":"The IDs of the slides in the presentation that should be moved. The slides in this list must be in existing presentation order, without duplicates.","type":"array","items":{"type":"string"}}}},"slides_v1_UpdateTableBorderPropertiesRequest":{"description":"Updates the properties of the table borders in a Table.","type":"object","properties":{"borderPosition":{"description":"The border position in the table range the updates should apply to. If a border position is not specified, the updates will apply to all borders in the table range.","enum":["ALL","BOTTOM","INNER","INNER_HORIZONTAL","INNER_VERTICAL","LEFT","OUTER","RIGHT","TOP"],"type":"string"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableBorderProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the table border solid fill color, set `fields` to `\"tableBorderFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"tableBorderProperties":{"$ref":"#/components/schemas/slides_v1_TableBorderProperties"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_UpdateTableCellPropertiesRequest":{"description":"Update the properties of a TableCell.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableCellProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the table cell background solid fill color, set `fields` to `\"tableCellBackgroundFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"tableCellProperties":{"$ref":"#/components/schemas/slides_v1_TableCellProperties"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_UpdateTableColumnPropertiesRequest":{"description":"Updates the properties of a Table column.","type":"object","properties":{"columnIndices":{"description":"The list of zero-based indices specifying which columns to update. If no indices are provided, all columns in the table will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `\"column_width\"`. If '\"column_width\"' is included in the field mask but the property is left unset, the column width will default to 406,400 EMU (32 points).","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"tableColumnProperties":{"$ref":"#/components/schemas/slides_v1_TableColumnProperties"}}},"slides_v1_UpdateTableRowPropertiesRequest":{"description":"Updates the properties of a Table row.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableRowProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `\"min_row_height\"`. If '\"min_row_height\"' is included in the field mask but the property is left unset, the minimum row height will default to 0.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"rowIndices":{"description":"The list of zero-based indices specifying which rows to update. If no indices are provided, all rows in the table will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"tableRowProperties":{"$ref":"#/components/schemas/slides_v1_TableRowProperties"}}},"slides_v1_UpdateTextStyleRequest":{"description":"Update the styling of text in a Shape or Table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `\"bold\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the shape or table with the text to be styled.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_TextStyle"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_UpdateVideoPropertiesRequest":{"description":"Update the properties of a Video.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `videoProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the video outline color, set `fields` to `\"outline.outlineFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the video the updates are applied to.","type":"string"},"videoProperties":{"$ref":"#/components/schemas/slides_v1_VideoProperties"}}},"slides_v1_Video":{"description":"A PageElement kind representing a video.","type":"object","properties":{"id":{"description":"The video source's unique identifier for this video.","type":"string"},"source":{"description":"The video source.","enum":["SOURCE_UNSPECIFIED","YOUTUBE","DRIVE"],"type":"string"},"url":{"description":"An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change.","type":"string"},"videoProperties":{"$ref":"#/components/schemas/slides_v1_VideoProperties"}}},"slides_v1_VideoProperties":{"description":"The properties of the Video.","type":"object","properties":{"autoPlay":{"description":"Whether to enable video autoplay when the page is displayed in present mode. Defaults to false.","type":"boolean"},"end":{"description":"The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end.","format":"uint32","type":"integer"},"mute":{"description":"Whether to mute the audio during video playback. Defaults to false.","type":"boolean"},"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"start":{"description":"The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning.","format":"uint32","type":"integer"}}},"slides_v1_WeightedFontFamily":{"description":"Represents a font family and weight used to style a TextRun.","type":"object","properties":{"fontFamily":{"description":"The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.","type":"string"},"weight":{"description":"The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` (\"normal\").","format":"int32","type":"integer"}}},"slides_v1_WordArt":{"description":"A PageElement kind representing word art.","type":"object","properties":{"renderedText":{"description":"The text rendered as word art.","type":"string"}}},"slides_v1_WriteControl":{"description":"Provides control over how write requests are executed.","type":"object","properties":{"requiredRevisionId":{"description":"The revision ID of the presentation required for the write request. If specified and the required revision ID doesn't match the presentation's current revision ID, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/presentations":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/presentations"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/slides/v1/rest","service":"slides","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Slides API","version":"v1","description":"Reads and writes Google Slides presentations."},"servers":[{"url":"https://slides.googleapis.com/"}],"paths":{"/v1/presentations":{"post":{"operationId":"slides.presentations.create","x-executor-toolPath":"slides.presentations.create","tags":["Google Slides API"],"description":"Creates a blank presentation using the title given in the request. If a `presentationId` is provided, it is used as the ID of the new presentation. Otherwise, a new ID is generated. Other fields in the request, including any provided content, are ignored. Returns the created presentation.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Presentation"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Presentation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}":{"get":{"operationId":"slides.presentations.get","x-executor-toolPath":"slides.presentations.get","tags":["Google Slides API"],"description":"Gets the latest version of the specified presentation.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The ID of the presentation to retrieve.","schema":{"description":"The ID of the presentation to retrieve.","type":"string"},"allowReserved":true},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the presentation. This allows viewing the presentation with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.","schema":{"description":"The comments view mode to apply to the presentation. This allows viewing the presentation with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Presentation"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations.readonly","https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}/pages/{pageObjectId}":{"get":{"operationId":"slides.presentations.pages.get","x-executor-toolPath":"slides.presentations.pages.get","tags":["Google Slides API"],"description":"Gets the latest version of the specified page in the presentation.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The ID of the presentation to retrieve.","schema":{"description":"The ID of the presentation to retrieve.","type":"string"}},{"name":"pageObjectId","in":"path","required":true,"description":"The object ID of the page to retrieve.","schema":{"description":"The object ID of the page to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"commentsViewMode","in":"query","required":false,"description":"The comments view mode to apply to the page. This allows viewing the page with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.","schema":{"description":"The comments view mode to apply to the page. This allows viewing the page with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Page"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations.readonly","https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail":{"get":{"operationId":"slides.presentations.pages.getThumbnail","x-executor-toolPath":"slides.presentations.pages.getThumbnail","tags":["Google Slides API"],"description":"Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an [expensive read request](https://developers.google.com/workspace/slides/limits) for quota purposes.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The ID of the presentation to retrieve.","schema":{"description":"The ID of the presentation to retrieve.","type":"string"}},{"name":"pageObjectId","in":"path","required":true,"description":"The object ID of the page whose thumbnail to retrieve.","schema":{"description":"The object ID of the page whose thumbnail to retrieve.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"thumbnailProperties.mimeType","in":"query","required":false,"description":"The optional mime type of the thumbnail image. If you don't specify the mime type, the mime type defaults to PNG.","schema":{"description":"The optional mime type of the thumbnail image. If you don't specify the mime type, the mime type defaults to PNG.","enum":["PNG"],"type":"string"},"style":"form","explode":false},{"name":"thumbnailProperties.thumbnailSize","in":"query","required":false,"description":"The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image.","schema":{"description":"The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image.","enum":["THUMBNAIL_SIZE_UNSPECIFIED","LARGE","MEDIUM","SMALL","WIDTH2000_PX"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_Thumbnail"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations.readonly","https://www.googleapis.com/auth/presentations"]}},"/v1/presentations/{presentationId}:batchUpdate":{"post":{"operationId":"slides.presentations.batchUpdate","x-executor-toolPath":"slides.presentations.batchUpdate","tags":["Google Slides API"],"description":"Applies one or more updates to the presentation. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies: the reply to the third request, and another empty reply, in that order. Because other users may be editing the presentation, the presentation might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the presentation should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.","parameters":[{"name":"presentationId","in":"path","required":true,"description":"The presentation to apply the updates to.","schema":{"description":"The presentation to apply the updates to.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_BatchUpdatePresentationRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/slides_v1_BatchUpdatePresentationResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/presentations"]}],"x-google-scopes":["https://www.googleapis.com/auth/presentations"]}}},"components":{"schemas":{"slides_v1_AddCommentReplyRequest":{"description":"Inserts a reply Post into a CommentThread.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread to add the reply to.","type":"string"},"post":{"$ref":"#/components/schemas/slides_v1_Post"}}},"slides_v1_AddCommentReplyResponse":{"description":"The result of creating a reply.","type":"object","properties":{"post":{"$ref":"#/components/schemas/slides_v1_Post"}}},"slides_v1_AffineTransform":{"description":"AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements.","type":"object","properties":{"scaleX":{"description":"The X coordinate scaling element.","format":"double","type":"number"},"scaleY":{"description":"The Y coordinate scaling element.","format":"double","type":"number"},"shearX":{"description":"The X coordinate shearing element.","format":"double","type":"number"},"shearY":{"description":"The Y coordinate shearing element.","format":"double","type":"number"},"translateX":{"description":"The X coordinate translation element.","format":"double","type":"number"},"translateY":{"description":"The Y coordinate translation element.","format":"double","type":"number"},"unit":{"description":"The units for translate elements.","enum":["UNIT_UNSPECIFIED","EMU","PT"],"type":"string"}}},"slides_v1_AutoText":{"description":"A TextElement kind that represents auto text.","type":"object","properties":{"content":{"description":"The rendered content of this auto text, if available.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_TextStyle"},"type":{"description":"The type of this auto text.","enum":["TYPE_UNSPECIFIED","SLIDE_NUMBER"],"type":"string"}}},"slides_v1_Autofit":{"description":"The autofit properties of a Shape. This property is only set for shapes that allow text.","type":"object","properties":{"autofitType":{"description":"The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case, the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values.","enum":["AUTOFIT_TYPE_UNSPECIFIED","NONE","TEXT_AUTOFIT","SHAPE_AUTOFIT"],"type":"string"},"fontScale":{"description":"The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that's rendered in the editor. This property is read-only.","format":"float","type":"number"},"lineSpacingReduction":{"description":"The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that's rendered in the editor. This property is read-only.","format":"float","type":"number"}}},"slides_v1_BatchUpdatePresentationRequest":{"description":"Request message for PresentationsService.BatchUpdatePresentation.","type":"object","properties":{"requests":{"description":"A list of updates to apply to the presentation.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Request"}},"writeControl":{"$ref":"#/components/schemas/slides_v1_WriteControl"}}},"slides_v1_BatchUpdatePresentationResponse":{"description":"Response message from a batch update.","type":"object","properties":{"commentUpdateState":{"description":"Whether comment updates were applied in the batch request.","enum":["COMMENT_UPDATE_STATE_UNSPECIFIED","NO_UPDATES_REQUESTED","ALL_SAVED","ALL_FAILED_UNKNOWN_REASON"],"type":"string"},"presentationId":{"description":"The presentation the updates were applied to.","type":"string"},"replies":{"description":"The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Response"}},"writeControl":{"$ref":"#/components/schemas/slides_v1_WriteControl"}}},"slides_v1_Bullet":{"description":"Describes the bullet of a paragraph.","type":"object","properties":{"bulletStyle":{"$ref":"#/components/schemas/slides_v1_TextStyle"},"glyph":{"description":"The rendered bullet glyph for this paragraph.","type":"string"},"listId":{"description":"The ID of the list this paragraph belongs to.","type":"string"},"nestingLevel":{"description":"The nesting level of this paragraph in the list.","format":"int32","type":"integer"}}},"slides_v1_ColorScheme":{"description":"The palette of predefined colors for a page.","type":"object","properties":{"colors":{"description":"The ThemeColorType and corresponding concrete color pairs.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_ThemeColorPair"}}}},"slides_v1_ColorStop":{"description":"A color and position in a gradient band.","type":"object","properties":{"alpha":{"description":"The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque.","format":"float","type":"number"},"color":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"},"position":{"description":"The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0].","format":"float","type":"number"}}},"slides_v1_CommentAnchor":{"description":"Contains a list of all locations in a `Page` that are anchored to a CommentThread via the same anchorId. Multiple separate anchors may refer to the same location, either within a `Page` or across different pages,","type":"object","properties":{"anchorId":{"description":"Output only. The unique ID of the comment anchor.","type":"string"},"objectAnchors":{"description":"Output only. All object ID-based locations within a page that refer to the anchor ID.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_ObjectAnchor"}}}},"slides_v1_CommentThread":{"description":"Represents a single comment thread inside a presentation.","type":"object","properties":{"anchorId":{"description":"The ID of the CommentAnchor in the presentation that this thread is tied to.","type":"string"},"commentId":{"description":"The unique ID of the comment thread.","type":"string"},"headPost":{"$ref":"#/components/schemas/slides_v1_Post"},"plainTextQuote":{"description":"The quoted text from the page element when the comment was created, formatted as plain-text.","type":"string"},"replies":{"description":"Replies to the head post.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Post"}},"status":{"description":"Whether the thread is open or resolved.","enum":["STATUS_UNSPECIFIED","OPEN","RESOLVED"],"type":"string"}}},"slides_v1_CreateImageRequest":{"description":"Creates an image.","type":"object","properties":{"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"},"url":{"description":"The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50 MB in size, can't exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF formats. The provided URL must be publicly accessible and up to 2 KB in length. The URL is saved with the image, and exposed through the Image.source_url field.","type":"string"}}},"slides_v1_CreateImageResponse":{"description":"The result of creating an image.","type":"object","properties":{"objectId":{"description":"The object ID of the created image.","type":"string"}}},"slides_v1_CreateLineRequest":{"description":"Creates a line.","type":"object","properties":{"category":{"description":"The category of the line to be created. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence. If you do not specify a value for `category`, but specify a value for `line_category`, then the specified `line_category` value is used. If you do not specify either, then STRAIGHT is used.","enum":["LINE_CATEGORY_UNSPECIFIED","STRAIGHT","BENT","CURVED"],"type":"string"},"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"lineCategory":{"description":"The category of the line to be created. *Deprecated*: use `category` instead. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence.","enum":["STRAIGHT","BENT","CURVED"],"type":"string"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"}}},"slides_v1_CreateLineResponse":{"description":"The result of creating a line.","type":"object","properties":{"objectId":{"description":"The object ID of the created line.","type":"string"}}},"slides_v1_CreateParagraphBulletsRequest":{"description":"Creates bullets for all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list.","type":"object","properties":{"bulletPreset":{"description":"The kinds of bullet glyphs to be used. Defaults to the `BULLET_DISC_CIRCLE_SQUARE` preset.","enum":["BULLET_DISC_CIRCLE_SQUARE","BULLET_DIAMONDX_ARROW3D_SQUARE","BULLET_CHECKBOX","BULLET_ARROW_DIAMOND_DISC","BULLET_STAR_CIRCLE_SQUARE","BULLET_ARROW3D_CIRCLE_SQUARE","BULLET_LEFTTRIANGLE_DIAMOND_DISC","BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE","BULLET_DIAMOND_CIRCLE_SQUARE","NUMBERED_DIGIT_ALPHA_ROMAN","NUMBERED_DIGIT_ALPHA_ROMAN_PARENS","NUMBERED_DIGIT_NESTED","NUMBERED_UPPERALPHA_ALPHA_ROMAN","NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT","NUMBERED_ZERODIGIT_ALPHA_ROMAN"],"type":"string"},"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the shape or table containing the text to add bullets to.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_CreateShapeRequest":{"description":"Creates a new shape.","type":"object","properties":{"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If empty, a unique identifier will be generated.","type":"string"},"shapeType":{"description":"The shape type.","enum":["TYPE_UNSPECIFIED","TEXT_BOX","RECTANGLE","ROUND_RECTANGLE","ELLIPSE","ARC","BENT_ARROW","BENT_UP_ARROW","BEVEL","BLOCK_ARC","BRACE_PAIR","BRACKET_PAIR","CAN","CHEVRON","CHORD","CLOUD","CORNER","CUBE","CURVED_DOWN_ARROW","CURVED_LEFT_ARROW","CURVED_RIGHT_ARROW","CURVED_UP_ARROW","DECAGON","DIAGONAL_STRIPE","DIAMOND","DODECAGON","DONUT","DOUBLE_WAVE","DOWN_ARROW","DOWN_ARROW_CALLOUT","FOLDED_CORNER","FRAME","HALF_FRAME","HEART","HEPTAGON","HEXAGON","HOME_PLATE","HORIZONTAL_SCROLL","IRREGULAR_SEAL_1","IRREGULAR_SEAL_2","LEFT_ARROW","LEFT_ARROW_CALLOUT","LEFT_BRACE","LEFT_BRACKET","LEFT_RIGHT_ARROW","LEFT_RIGHT_ARROW_CALLOUT","LEFT_RIGHT_UP_ARROW","LEFT_UP_ARROW","LIGHTNING_BOLT","MATH_DIVIDE","MATH_EQUAL","MATH_MINUS","MATH_MULTIPLY","MATH_NOT_EQUAL","MATH_PLUS","MOON","NO_SMOKING","NOTCHED_RIGHT_ARROW","OCTAGON","PARALLELOGRAM","PENTAGON","PIE","PLAQUE","PLUS","QUAD_ARROW","QUAD_ARROW_CALLOUT","RIBBON","RIBBON_2","RIGHT_ARROW","RIGHT_ARROW_CALLOUT","RIGHT_BRACE","RIGHT_BRACKET","ROUND_1_RECTANGLE","ROUND_2_DIAGONAL_RECTANGLE","ROUND_2_SAME_RECTANGLE","RIGHT_TRIANGLE","SMILEY_FACE","SNIP_1_RECTANGLE","SNIP_2_DIAGONAL_RECTANGLE","SNIP_2_SAME_RECTANGLE","SNIP_ROUND_RECTANGLE","STAR_10","STAR_12","STAR_16","STAR_24","STAR_32","STAR_4","STAR_5","STAR_6","STAR_7","STAR_8","STRIPED_RIGHT_ARROW","SUN","TRAPEZOID","TRIANGLE","UP_ARROW","UP_ARROW_CALLOUT","UP_DOWN_ARROW","UTURN_ARROW","VERTICAL_SCROLL","WAVE","WEDGE_ELLIPSE_CALLOUT","WEDGE_RECTANGLE_CALLOUT","WEDGE_ROUND_RECTANGLE_CALLOUT","FLOW_CHART_ALTERNATE_PROCESS","FLOW_CHART_COLLATE","FLOW_CHART_CONNECTOR","FLOW_CHART_DECISION","FLOW_CHART_DELAY","FLOW_CHART_DISPLAY","FLOW_CHART_DOCUMENT","FLOW_CHART_EXTRACT","FLOW_CHART_INPUT_OUTPUT","FLOW_CHART_INTERNAL_STORAGE","FLOW_CHART_MAGNETIC_DISK","FLOW_CHART_MAGNETIC_DRUM","FLOW_CHART_MAGNETIC_TAPE","FLOW_CHART_MANUAL_INPUT","FLOW_CHART_MANUAL_OPERATION","FLOW_CHART_MERGE","FLOW_CHART_MULTIDOCUMENT","FLOW_CHART_OFFLINE_STORAGE","FLOW_CHART_OFFPAGE_CONNECTOR","FLOW_CHART_ONLINE_STORAGE","FLOW_CHART_OR","FLOW_CHART_PREDEFINED_PROCESS","FLOW_CHART_PREPARATION","FLOW_CHART_PROCESS","FLOW_CHART_PUNCHED_CARD","FLOW_CHART_PUNCHED_TAPE","FLOW_CHART_SORT","FLOW_CHART_SUMMING_JUNCTION","FLOW_CHART_TERMINATOR","ARROW_EAST","ARROW_NORTH_EAST","ARROW_NORTH","SPEECH","STARBURST","TEARDROP","ELLIPSE_RIBBON","ELLIPSE_RIBBON_2","CLOUD_CALLOUT","CUSTOM"],"type":"string"}}},"slides_v1_CreateShapeResponse":{"description":"The result of creating a shape.","type":"object","properties":{"objectId":{"description":"The object ID of the created shape.","type":"string"}}},"slides_v1_CreateSheetsChartRequest":{"description":"Creates an embedded Google Sheets chart. NOTE: Chart creation requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive.file, or drive OAuth scopes.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet.","format":"int32","type":"integer"},"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"linkingMode":{"description":"The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked.","enum":["NOT_LINKED_IMAGE","LINKED"],"type":"string"},"objectId":{"description":"A user-supplied object ID. If specified, the ID must be unique among all pages and page elements in the presentation. The ID should start with a word character [a-zA-Z0-9_] and then followed by any number of the following characters [a-zA-Z0-9_-:]. The length of the ID should not be less than 5 or greater than 50. If empty, a unique identifier will be generated.","type":"string"},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the chart. You might need to add a resource key to the HTTP header for a subset of old files. For more information, see [Access link-shared files using resource keys](https://developers.google.com/drive/api/v3/resource-keys).","type":"string"}}},"slides_v1_CreateSheetsChartResponse":{"description":"The result of creating an embedded Google Sheets chart.","type":"object","properties":{"objectId":{"description":"The object ID of the created chart.","type":"string"}}},"slides_v1_CreateSlideRequest":{"description":"Creates a slide.","type":"object","properties":{"insertionIndex":{"description":"The optional zero-based index indicating where to insert the slides. If you don't specify an index, the slide is created at the end.","format":"int32","type":"integer"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The ID length must be between 5 and 50 characters, inclusive. If you don't specify an ID, a unique one is generated.","type":"string"},"placeholderIdMappings":{"description":"An optional list of object ID mappings from the placeholder(s) on the layout to the placeholders that are created on the slide from the specified layout. Can only be used when `slide_layout_reference` is specified.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_LayoutPlaceholderIdMapping"}},"slideLayoutReference":{"$ref":"#/components/schemas/slides_v1_LayoutReference"}}},"slides_v1_CreateSlideResponse":{"description":"The result of creating a slide.","type":"object","properties":{"objectId":{"description":"The object ID of the created slide.","type":"string"}}},"slides_v1_CreateTableRequest":{"description":"Creates a new table.","type":"object","properties":{"columns":{"description":"Number of columns in the table.","format":"int32","type":"integer"},"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"},"rows":{"description":"Number of rows in the table.","format":"int32","type":"integer"}}},"slides_v1_CreateTableResponse":{"description":"The result of creating a table.","type":"object","properties":{"objectId":{"description":"The object ID of the created table.","type":"string"}}},"slides_v1_CreateVideoRequest":{"description":"Creates a video. NOTE: Creating a video from Google Drive requires that the requesting app have at least one of the drive, drive.readonly, or drive.file OAuth scopes.","type":"object","properties":{"elementProperties":{"$ref":"#/components/schemas/slides_v1_PageElementProperties"},"id":{"description":"The video source's unique identifier for this video. e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is 7U3axjORYZ0. For a Google Drive video https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. To access a Google Drive video file, you might need to add a resource key to the HTTP header for a subset of old files. For more information, see [Access link-shared files using resource keys](https://developers.google.com/drive/api/v3/resource-keys).","type":"string"},"objectId":{"description":"A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"},"source":{"description":"The video source.","enum":["SOURCE_UNSPECIFIED","YOUTUBE","DRIVE"],"type":"string"}}},"slides_v1_CreateVideoResponse":{"description":"The result of creating a video.","type":"object","properties":{"objectId":{"description":"The object ID of the created video.","type":"string"}}},"slides_v1_CropProperties":{"description":"The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container.","type":"object","properties":{"angle":{"description":"The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset.","format":"float","type":"number"},"bottomOffset":{"description":"The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height.","format":"float","type":"number"},"leftOffset":{"description":"The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width.","format":"float","type":"number"},"rightOffset":{"description":"The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width.","format":"float","type":"number"},"topOffset":{"description":"The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height.","format":"float","type":"number"}}},"slides_v1_DeleteCommentReplyRequest":{"description":"Deletes a reply Post from a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains a comment action. - The reply post contains an assignee.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"postId":{"description":"The ID of the reply Post being deleted.","type":"string"}}},"slides_v1_DeleteCommentRequest":{"description":"Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread that is being deleted.","type":"string"}}},"slides_v1_DeleteObjectRequest":{"description":"Deletes an object, either pages or page elements, from the presentation.","type":"object","properties":{"objectId":{"description":"The object ID of the page or page element to delete. If after a delete operation a group contains only 1 or no page elements, the group is also deleted. If a placeholder is deleted on a layout, any empty inheriting placeholders are also deleted.","type":"string"}}},"slides_v1_DeleteParagraphBulletsRequest":{"description":"Deletes bullets from all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the shape or table containing the text to delete bullets from.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_DeleteTableColumnRequest":{"description":"Deletes a column from a table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"tableObjectId":{"description":"The table to delete columns from.","type":"string"}}},"slides_v1_DeleteTableRowRequest":{"description":"Deletes a row from a table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"tableObjectId":{"description":"The table to delete rows from.","type":"string"}}},"slides_v1_DeleteTextRequest":{"description":"Deletes text from a shape or a table cell.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the shape or table from which the text will be deleted.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_Dimension":{"description":"A magnitude in a single direction in the specified units.","type":"object","properties":{"magnitude":{"description":"The magnitude.","format":"double","type":"number"},"unit":{"description":"The units for magnitude.","enum":["UNIT_UNSPECIFIED","EMU","PT"],"type":"string"}}},"slides_v1_DuplicateObjectRequest":{"description":"Duplicates a slide or page element. When duplicating a slide, the duplicate slide will be created immediately following the specified slide. When duplicating a page element, the duplicate will be placed on the same page at the same position as the original.","type":"object","properties":{"objectId":{"description":"The ID of the object to duplicate.","type":"string"},"objectIds":{"description":"The object being duplicated may contain other objects, for example when duplicating a slide or a group page element. This map defines how the IDs of duplicated objects are generated: the keys are the IDs of the original objects and its values are the IDs that will be assigned to the corresponding duplicate object. The ID of the source object's duplicate may be specified in this map as well, using the same value of the `object_id` field as a key and the newly desired ID as the value. All keys must correspond to existing IDs in the presentation. All values must be unique in the presentation and must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or greater than 50. If any IDs of source objects are omitted from the map, a new random ID will be assigned. If the map is empty or unset, all duplicate objects will receive a new random ID.","type":"object","additionalProperties":{"type":"string"}}}},"slides_v1_DuplicateObjectResponse":{"description":"The response of duplicating an object.","type":"object","properties":{"objectId":{"description":"The ID of the new duplicate object.","type":"string"}}},"slides_v1_Group":{"description":"A PageElement kind representing a joined collection of PageElements.","type":"object","properties":{"children":{"description":"The collection of elements in the group. The minimum size of a group is 2.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_PageElement"}}}},"slides_v1_GroupObjectsRequest":{"description":"Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.","type":"object","properties":{"childrenObjectIds":{"description":"The object IDs of the objects to group. Only page elements can be grouped. There should be at least two page elements on the same page that are not already in another group. Some page elements, such as videos, tables and placeholders cannot be grouped.","type":"array","items":{"type":"string"}},"groupObjectId":{"description":"A user-supplied object ID for the group to be created. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"}}},"slides_v1_GroupObjectsResponse":{"description":"The result of grouping objects.","type":"object","properties":{"objectId":{"description":"The object ID of the created group.","type":"string"}}},"slides_v1_Image":{"description":"A PageElement kind representing an image.","type":"object","properties":{"contentUrl":{"description":"An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change.","type":"string"},"imageProperties":{"$ref":"#/components/schemas/slides_v1_ImageProperties"},"placeholder":{"$ref":"#/components/schemas/slides_v1_Placeholder"},"sourceUrl":{"description":"The source URL is the URL used to insert the image. The source URL can be empty.","type":"string"}}},"slides_v1_ImageProperties":{"description":"The properties of the Image.","type":"object","properties":{"brightness":{"description":"The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only.","format":"float","type":"number"},"contrast":{"description":"The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only.","format":"float","type":"number"},"cropProperties":{"$ref":"#/components/schemas/slides_v1_CropProperties"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"recolor":{"$ref":"#/components/schemas/slides_v1_Recolor"},"shadow":{"$ref":"#/components/schemas/slides_v1_Shadow"},"transparency":{"description":"The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only.","format":"float","type":"number"}}},"slides_v1_InsertCommentRequest":{"description":"Inserts a CommentThread into the presentation.","type":"object","properties":{"assigneeEmailAddress":{"description":"Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units.","type":"string"},"content":{"description":"The text of the comment, as plain text. This text content will be handled similarly to comments created in the Slides editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"objectId":{"description":"The object ID of the Page or PageElement that is tied to this comment. If the specified object_id is a Group, the comment will be anchored to at most 100 of the group's non-group descendants.","type":"string"},"shapeTextAnchor":{"$ref":"#/components/schemas/slides_v1_ShapeTextAnchor"},"tableAnchor":{"$ref":"#/components/schemas/slides_v1_TableAnchor"},"tableCellTextAnchor":{"$ref":"#/components/schemas/slides_v1_TableCellTextAnchor"}}},"slides_v1_InsertCommentResponse":{"description":"The result of creating a comment.","type":"object","properties":{"commentThread":{"$ref":"#/components/schemas/slides_v1_CommentThread"}}},"slides_v1_InsertTableColumnsRequest":{"description":"Inserts columns into a table. Other columns in the table will be resized to fit the new column.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"insertRight":{"description":"Whether to insert new columns to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left.","type":"boolean"},"number":{"description":"The number of columns to be inserted. Maximum 20 per request.","format":"int32","type":"integer"},"tableObjectId":{"description":"The table to insert columns into.","type":"string"}}},"slides_v1_InsertTableRowsRequest":{"description":"Inserts rows into a table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"insertBelow":{"description":"Whether to insert new rows below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell.","type":"boolean"},"number":{"description":"The number of rows to be inserted. Maximum 20 per request.","format":"int32","type":"integer"},"tableObjectId":{"description":"The table to insert rows into.","type":"string"}}},"slides_v1_InsertTextRequest":{"description":"Inserts text into a shape or a table cell.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"insertionIndex":{"description":"The index where the text will be inserted, in Unicode code units, based on TextElement indexes. The index is zero-based and is computed from the start of the string. The index may be adjusted to prevent insertions inside Unicode grapheme clusters. In these cases, the text will be inserted immediately after the grapheme cluster.","format":"int32","type":"integer"},"objectId":{"description":"The object ID of the shape or table where the text will be inserted.","type":"string"},"text":{"description":"The text to be inserted. Inserting a newline character will implicitly create a new ParagraphMarker at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text will be added to the TextRun that exists at the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text.","type":"string"}}},"slides_v1_LayoutPlaceholderIdMapping":{"description":"The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout.","type":"object","properties":{"layoutPlaceholder":{"$ref":"#/components/schemas/slides_v1_Placeholder"},"layoutPlaceholderObjectId":{"description":"The object ID of the placeholder on a layout that will be applied to a slide.","type":"string"},"objectId":{"description":"A user-supplied object ID for the placeholder identified above that to be created onto a slide. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.","type":"string"}}},"slides_v1_LayoutProperties":{"description":"The properties of Page are only relevant for pages with page_type LAYOUT.","type":"object","properties":{"displayName":{"description":"The human-readable name of the layout.","type":"string"},"masterObjectId":{"description":"The object ID of the master that this layout is based on.","type":"string"},"name":{"description":"The name of the layout.","type":"string"}}},"slides_v1_LayoutReference":{"description":"Slide layout reference. This may reference either: - A predefined layout - One of the layouts in the presentation.","type":"object","properties":{"layoutId":{"description":"Layout ID: the object ID of one of the layouts in the presentation.","type":"string"},"predefinedLayout":{"description":"Predefined layout.","enum":["PREDEFINED_LAYOUT_UNSPECIFIED","BLANK","CAPTION_ONLY","TITLE","TITLE_AND_BODY","TITLE_AND_TWO_COLUMNS","TITLE_ONLY","SECTION_HEADER","SECTION_TITLE_AND_DESCRIPTION","ONE_COLUMN_TEXT","MAIN_POINT","BIG_NUMBER"],"type":"string"}}},"slides_v1_Line":{"description":"A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector.","type":"object","properties":{"lineCategory":{"description":"The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest.","enum":["LINE_CATEGORY_UNSPECIFIED","STRAIGHT","BENT","CURVED"],"type":"string"},"lineProperties":{"$ref":"#/components/schemas/slides_v1_LineProperties"},"lineType":{"description":"The type of the line.","enum":["TYPE_UNSPECIFIED","STRAIGHT_CONNECTOR_1","BENT_CONNECTOR_2","BENT_CONNECTOR_3","BENT_CONNECTOR_4","BENT_CONNECTOR_5","CURVED_CONNECTOR_2","CURVED_CONNECTOR_3","CURVED_CONNECTOR_4","CURVED_CONNECTOR_5","STRAIGHT_LINE"],"type":"string"}}},"slides_v1_LineConnection":{"description":"The properties for one end of a Line connection.","type":"object","properties":{"connectedObjectId":{"description":"The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line.","type":"string"},"connectionSiteIndex":{"description":"The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in both the description of the \"cxn\" attribute in section 20.1.9.9 and \"Annex H. Example Predefined DrawingML Shape and Text Geometries\" of \"Office Open XML File Formats - Fundamentals and Markup Language Reference\", part 1 of [ECMA-376 5th edition](https://ecma-international.org/publications-and-standards/standards/ecma-376/). The position of each connection site can also be viewed from Slides editor.","format":"int32","type":"integer"}}},"slides_v1_LineFill":{"description":"The fill of the line.","type":"object","properties":{"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_LineProperties":{"description":"The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor.","type":"object","properties":{"dashStyle":{"description":"The dash style of the line.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH","DASH_DOT","LONG_DASH","LONG_DASH_DOT"],"type":"string"},"endArrow":{"description":"The style of the arrow at the end of the line.","enum":["ARROW_STYLE_UNSPECIFIED","NONE","STEALTH_ARROW","FILL_ARROW","FILL_CIRCLE","FILL_SQUARE","FILL_DIAMOND","OPEN_ARROW","OPEN_CIRCLE","OPEN_SQUARE","OPEN_DIAMOND"],"type":"string"},"endConnection":{"$ref":"#/components/schemas/slides_v1_LineConnection"},"lineFill":{"$ref":"#/components/schemas/slides_v1_LineFill"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"startArrow":{"description":"The style of the arrow at the beginning of the line.","enum":["ARROW_STYLE_UNSPECIFIED","NONE","STEALTH_ARROW","FILL_ARROW","FILL_CIRCLE","FILL_SQUARE","FILL_DIAMOND","OPEN_ARROW","OPEN_CIRCLE","OPEN_SQUARE","OPEN_DIAMOND"],"type":"string"},"startConnection":{"$ref":"#/components/schemas/slides_v1_LineConnection"},"weight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_Link":{"description":"A hypertext link.","type":"object","properties":{"pageObjectId":{"description":"If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist.","type":"string"},"relativeLink":{"description":"If set, indicates this is a link to a slide in this presentation, addressed by its position.","enum":["RELATIVE_SLIDE_LINK_UNSPECIFIED","NEXT_SLIDE","PREVIOUS_SLIDE","FIRST_SLIDE","LAST_SLIDE"],"type":"string"},"slideIndex":{"description":"If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index.","format":"int32","type":"integer"},"url":{"description":"If set, indicates this is a link to the external web page at this URL.","type":"string"}}},"slides_v1_List":{"description":"A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID.","type":"object","properties":{"listId":{"description":"The ID of the list.","type":"string"},"nestingLevel":{"description":"A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive.","type":"object","additionalProperties":{"$ref":"#/components/schemas/slides_v1_NestingLevel"}}}},"slides_v1_MasterProperties":{"description":"The properties of Page that are only relevant for pages with page_type MASTER.","type":"object","properties":{"displayName":{"description":"The human-readable name of the master.","type":"string"}}},"slides_v1_MergeTableCellsRequest":{"description":"Merges cells in a Table.","type":"object","properties":{"objectId":{"description":"The object ID of the table.","type":"string"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_NestingLevel":{"description":"Contains properties describing the look and feel of a list bullet at a given level of nesting.","type":"object","properties":{"bulletStyle":{"$ref":"#/components/schemas/slides_v1_TextStyle"}}},"slides_v1_NotesProperties":{"description":"The properties of Page that are only relevant for pages with page_type NOTES.","type":"object","properties":{"speakerNotesObjectId":{"description":"The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID.","type":"string"}}},"slides_v1_ObjectAnchor":{"description":"Represents comment anchor data tied to a Slides object, for example a `Page` or PageElement.","type":"object","properties":{"objectId":{"description":"Output only. The page or page element that the comment thread is anchored to.","type":"string"},"shapeTextAnchors":{"$ref":"#/components/schemas/slides_v1_ShapeTextAnchors"},"tableCellAnchors":{"$ref":"#/components/schemas/slides_v1_TableCellAnchors"}}},"slides_v1_OpaqueColor":{"description":"A themeable solid color value.","type":"object","properties":{"rgbColor":{"$ref":"#/components/schemas/slides_v1_RgbColor"},"themeColor":{"description":"An opaque theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","DARK1","LIGHT1","DARK2","LIGHT2","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","HYPERLINK","FOLLOWED_HYPERLINK","TEXT1","BACKGROUND1","TEXT2","BACKGROUND2"],"type":"string"}}},"slides_v1_OptionalColor":{"description":"A color that can either be fully opaque or fully transparent.","type":"object","properties":{"opaqueColor":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"}}},"slides_v1_Outline":{"description":"The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind.","type":"object","properties":{"dashStyle":{"description":"The dash style of the outline.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH","DASH_DOT","LONG_DASH","LONG_DASH_DOT"],"type":"string"},"outlineFill":{"$ref":"#/components/schemas/slides_v1_OutlineFill"},"propertyState":{"description":"The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"weight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_OutlineFill":{"description":"The fill of the outline.","type":"object","properties":{"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_Page":{"description":"A page in a presentation.","type":"object","properties":{"commentAnchors":{"description":"Output only. The comment anchors present on the page.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_CommentAnchor"}},"comments":{"description":"Output only. The comment threads associated with the page. Only populated if the page was fetched via a GetPageRequest with a populated comments_view_mode. Otherwise, comments are returned in the Presentation via the GetPresentationRequest.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the page. Only populated if the page was fetched via a GetPageRequest with a populated comments_view_mode.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"layoutProperties":{"$ref":"#/components/schemas/slides_v1_LayoutProperties"},"masterProperties":{"$ref":"#/components/schemas/slides_v1_MasterProperties"},"notesProperties":{"$ref":"#/components/schemas/slides_v1_NotesProperties"},"objectId":{"description":"The object ID for this page. Object IDs used by Page and PageElement share the same namespace.","type":"string"},"pageElements":{"description":"The page elements rendered on the page.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_PageElement"}},"pageProperties":{"$ref":"#/components/schemas/slides_v1_PageProperties"},"pageType":{"description":"The type of the page.","enum":["SLIDE","MASTER","LAYOUT","NOTES","NOTES_MASTER"],"type":"string"},"revisionId":{"description":"Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes.","type":"string"},"slideProperties":{"$ref":"#/components/schemas/slides_v1_SlideProperties"}}},"slides_v1_PageBackgroundFill":{"description":"The page background fill.","type":"object","properties":{"propertyState":{"description":"The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"},"stretchedPictureFill":{"$ref":"#/components/schemas/slides_v1_StretchedPictureFill"}}},"slides_v1_PageElement":{"description":"A visual element rendered on a page.","type":"object","properties":{"description":{"description":"The description of the page element. Combined with title to display alt text. The field is not supported for Group elements.","type":"string"},"elementGroup":{"$ref":"#/components/schemas/slides_v1_Group"},"image":{"$ref":"#/components/schemas/slides_v1_Image"},"line":{"$ref":"#/components/schemas/slides_v1_Line"},"objectId":{"description":"The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace.","type":"string"},"shape":{"$ref":"#/components/schemas/slides_v1_Shape"},"sheetsChart":{"$ref":"#/components/schemas/slides_v1_SheetsChart"},"size":{"$ref":"#/components/schemas/slides_v1_Size"},"speakerSpotlight":{"$ref":"#/components/schemas/slides_v1_SpeakerSpotlight"},"table":{"$ref":"#/components/schemas/slides_v1_Table"},"title":{"description":"The title of the page element. Combined with description to display alt text. The field is not supported for Group elements.","type":"string"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"},"video":{"$ref":"#/components/schemas/slides_v1_Video"},"wordArt":{"$ref":"#/components/schemas/slides_v1_WordArt"}}},"slides_v1_PageElementProperties":{"description":"Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both `size` and `transform`, but the visual size will be unchanged.","type":"object","properties":{"pageObjectId":{"description":"The object ID of the page where the element is located.","type":"string"},"size":{"$ref":"#/components/schemas/slides_v1_Size"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"}}},"slides_v1_PageProperties":{"description":"The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties.","type":"object","properties":{"colorScheme":{"$ref":"#/components/schemas/slides_v1_ColorScheme"},"pageBackgroundFill":{"$ref":"#/components/schemas/slides_v1_PageBackgroundFill"}}},"slides_v1_ParagraphMarker":{"description":"A TextElement kind that represents the beginning of a new paragraph.","type":"object","properties":{"bullet":{"$ref":"#/components/schemas/slides_v1_Bullet"},"style":{"$ref":"#/components/schemas/slides_v1_ParagraphStyle"}}},"slides_v1_ParagraphStyle":{"description":"Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message.","type":"object","properties":{"alignment":{"description":"The text alignment for this paragraph.","enum":["ALIGNMENT_UNSPECIFIED","START","CENTER","END","JUSTIFIED"],"type":"string"},"direction":{"description":"The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited.","enum":["TEXT_DIRECTION_UNSPECIFIED","LEFT_TO_RIGHT","RIGHT_TO_LEFT"],"type":"string"},"indentEnd":{"$ref":"#/components/schemas/slides_v1_Dimension"},"indentFirstLine":{"$ref":"#/components/schemas/slides_v1_Dimension"},"indentStart":{"$ref":"#/components/schemas/slides_v1_Dimension"},"lineSpacing":{"description":"The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.","format":"float","type":"number"},"spaceAbove":{"$ref":"#/components/schemas/slides_v1_Dimension"},"spaceBelow":{"$ref":"#/components/schemas/slides_v1_Dimension"},"spacingMode":{"description":"The spacing mode for the paragraph.","enum":["SPACING_MODE_UNSPECIFIED","NEVER_COLLAPSE","COLLAPSE_LISTS"],"type":"string"}}},"slides_v1_Placeholder":{"description":"The placeholder information that uniquely identifies a placeholder shape.","type":"object","properties":{"index":{"description":"The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values.","format":"int32","type":"integer"},"parentObjectId":{"description":"The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape.","type":"string"},"type":{"description":"The type of the placeholder.","enum":["NONE","BODY","CHART","CLIP_ART","CENTERED_TITLE","DIAGRAM","DATE_AND_TIME","FOOTER","HEADER","MEDIA","OBJECT","PICTURE","SLIDE_NUMBER","SUBTITLE","TABLE","TITLE","SLIDE_IMAGE"],"type":"string"}}},"slides_v1_Post":{"description":"Represents a single post in a comment thread.","type":"object","properties":{"assigneeEmail":{"description":"Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assignee_email` exceeds 2048 UTF-8 code units.","type":"string"},"author":{"$ref":"#/components/schemas/slides_v1_PostAuthor"},"commentAction":{"description":"Action taken as part of creating the post.","enum":["COMMENT_ACTION_TYPE_UNSPECIFIED","NO_COMMENT_ACTION_CHANGE","RESOLVE","REOPEN"],"type":"string"},"content":{"description":"The content of the post. Required to be non-empty if comment_action is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Slides editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.","type":"string"},"contentHtml":{"description":"Output only. The content of the post as HTML.","type":"string"},"createTime":{"description":"Output only. The time the post was created.","format":"google-datetime","type":"string"},"deleted":{"description":"Output only. Whether the post is deleted. If `true`, content and author fields will be empty.","type":"boolean"},"fromCopiedPresentation":{"description":"Output only. Whether the post is from a copied presentation. This field cannot be set directly by callers.","type":"boolean"},"fromImportedPresentation":{"description":"Output only. Whether the post is from an imported presentation. This field cannot be set directly by callers.","type":"boolean"},"postId":{"description":"Output only. The unique ID of the post.","type":"string"},"updateTime":{"description":"Output only. The time the post was last updated.","format":"google-datetime","type":"string"}}},"slides_v1_PostAuthor":{"description":"Represents a user who authored a comment post.","type":"object","properties":{"anonymous":{"description":"Whether the user is anonymous.","type":"boolean"},"displayName":{"description":"The display name of the user. May be absent if the author is anonymous.","type":"string"},"me":{"description":"Whether the user is the authenticated user making the request.","type":"boolean"},"user":{"description":"The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported presentation.","type":"string"}}},"slides_v1_Presentation":{"description":"A Google Slides presentation.","type":"object","properties":{"comments":{"description":"Output only. The comment threads associated with the presentation.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_CommentThread"}},"commentsViewMode":{"description":"Output only. The comments view mode applied to the presentation.","enum":["COMMENTS_VIEW_MODE_UNSPECIFIED","COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS","COMMENTS_VIEW_MODE_OMITTED","COMMENTS_VIEW_MODE_INCLUDED"],"type":"string"},"layouts":{"description":"The layouts in the presentation. A layout is a template that determines how content is arranged and styled on the slides that inherit from that layout.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Page"}},"locale":{"description":"The locale of the presentation, as an IETF BCP 47 language tag.","type":"string"},"masters":{"description":"The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts. They serve three purposes: - Placeholder shapes on a master contain the default text styles and shape properties of all placeholder shapes on pages that use that master. - The master page properties define the common page properties inherited by its layouts. - Any other shapes on the master slide appear on all slides using that master, regardless of their layout.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Page"}},"notesMaster":{"$ref":"#/components/schemas/slides_v1_Page"},"pageSize":{"$ref":"#/components/schemas/slides_v1_Size"},"presentationId":{"description":"The ID of the presentation.","type":"string"},"revisionId":{"description":"Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but a nebulous string. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes.","type":"string"},"slides":{"description":"The slides in the presentation. A slide inherits properties from a slide layout.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_Page"}},"title":{"description":"The title of the presentation.","type":"string"}}},"slides_v1_Range":{"description":"Specifies a contiguous range of an indexed collection, such as characters in text.","type":"object","properties":{"endIndex":{"description":"The optional zero-based index of the end of the collection. Required for `FIXED_RANGE` ranges.","format":"int32","type":"integer"},"startIndex":{"description":"The optional zero-based index of the beginning of the collection. Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges.","format":"int32","type":"integer"},"type":{"description":"The type of range.","enum":["RANGE_TYPE_UNSPECIFIED","FIXED_RANGE","FROM_START_INDEX","ALL"],"type":"string"}}},"slides_v1_Recolor":{"description":"A recolor effect applied on an image.","type":"object","properties":{"name":{"description":"The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only.","enum":["NONE","LIGHT1","LIGHT2","LIGHT3","LIGHT4","LIGHT5","LIGHT6","LIGHT7","LIGHT8","LIGHT9","LIGHT10","DARK1","DARK2","DARK3","DARK4","DARK5","DARK6","DARK7","DARK8","DARK9","DARK10","GRAYSCALE","NEGATIVE","SEPIA","CUSTOM"],"type":"string"},"recolorStops":{"description":"The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_ColorStop"}}}},"slides_v1_RefreshSheetsChartRequest":{"description":"Refreshes an embedded Google Sheets chart by replacing it with the latest version of the chart from Google Sheets. NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.","type":"object","properties":{"objectId":{"description":"The object ID of the chart to refresh.","type":"string"}}},"slides_v1_ReplaceAllShapesWithImageRequest":{"description":"Replaces all shapes that match the given criteria with the provided image. The images replacing the shapes are rectangular after being inserted into the presentation and do not take on the forms of the shapes.","type":"object","properties":{"containsText":{"$ref":"#/components/schemas/slides_v1_SubstringMatchCriteria"},"imageReplaceMethod":{"description":"The image replace method. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence. If you do not specify a value for `image_replace_method`, but specify a value for `replace_method`, then the specified `replace_method` value is used. If you do not specify either, then CENTER_INSIDE is used.","enum":["IMAGE_REPLACE_METHOD_UNSPECIFIED","CENTER_INSIDE","CENTER_CROP"],"type":"string"},"imageUrl":{"description":"The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field.","type":"string"},"pageObjectIds":{"description":"If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation.","type":"array","items":{"type":"string"}},"replaceMethod":{"description":"The replace method. *Deprecated*: use `image_replace_method` instead. If you specify both a `replace_method` and an `image_replace_method`, the `image_replace_method` takes precedence.","enum":["CENTER_INSIDE","CENTER_CROP"],"type":"string"}}},"slides_v1_ReplaceAllShapesWithImageResponse":{"description":"The result of replacing shapes with an image.","type":"object","properties":{"occurrencesChanged":{"description":"The number of shapes replaced with images.","format":"int32","type":"integer"}}},"slides_v1_ReplaceAllShapesWithSheetsChartRequest":{"description":"Replaces all shapes that match the given criteria with the provided Google Sheets chart. The chart will be scaled and centered to fit within the bounds of the original shape. NOTE: Replacing shapes with a chart requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet.","format":"int32","type":"integer"},"containsText":{"$ref":"#/components/schemas/slides_v1_SubstringMatchCriteria"},"linkingMode":{"description":"The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked.","enum":["NOT_LINKED_IMAGE","LINKED"],"type":"string"},"pageObjectIds":{"description":"If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation.","type":"array","items":{"type":"string"}},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the chart.","type":"string"}}},"slides_v1_ReplaceAllShapesWithSheetsChartResponse":{"description":"The result of replacing shapes with a Google Sheets chart.","type":"object","properties":{"occurrencesChanged":{"description":"The number of shapes replaced with charts.","format":"int32","type":"integer"}}},"slides_v1_ReplaceAllTextRequest":{"description":"Replaces all instances of text matching a criteria with replace text.","type":"object","properties":{"containsText":{"$ref":"#/components/schemas/slides_v1_SubstringMatchCriteria"},"pageObjectIds":{"description":"If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes master, or if a page with that object ID doesn't exist in the presentation.","type":"array","items":{"type":"string"}},"replaceText":{"description":"The text that will replace the matched text.","type":"string"}}},"slides_v1_ReplaceAllTextResponse":{"description":"The result of replacing text.","type":"object","properties":{"occurrencesChanged":{"description":"The number of occurrences changed by replacing all text.","format":"int32","type":"integer"}}},"slides_v1_ReplaceImageRequest":{"description":"Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image.","type":"object","properties":{"imageObjectId":{"description":"The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.","type":"string"},"imageReplaceMethod":{"description":"The replacement method.","enum":["IMAGE_REPLACE_METHOD_UNSPECIFIED","CENTER_INSIDE","CENTER_CROP"],"type":"string"},"url":{"description":"The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URL can't surpass 2 KB in length. The URL is saved with the image, and exposed through the Image.source_url field.","type":"string"}}},"slides_v1_Request":{"description":"A single kind of update to apply to a presentation.","type":"object","properties":{"addCommentReply":{"$ref":"#/components/schemas/slides_v1_AddCommentReplyRequest"},"createImage":{"$ref":"#/components/schemas/slides_v1_CreateImageRequest"},"createLine":{"$ref":"#/components/schemas/slides_v1_CreateLineRequest"},"createParagraphBullets":{"$ref":"#/components/schemas/slides_v1_CreateParagraphBulletsRequest"},"createShape":{"$ref":"#/components/schemas/slides_v1_CreateShapeRequest"},"createSheetsChart":{"$ref":"#/components/schemas/slides_v1_CreateSheetsChartRequest"},"createSlide":{"$ref":"#/components/schemas/slides_v1_CreateSlideRequest"},"createTable":{"$ref":"#/components/schemas/slides_v1_CreateTableRequest"},"createVideo":{"$ref":"#/components/schemas/slides_v1_CreateVideoRequest"},"deleteComment":{"$ref":"#/components/schemas/slides_v1_DeleteCommentRequest"},"deleteCommentReply":{"$ref":"#/components/schemas/slides_v1_DeleteCommentReplyRequest"},"deleteObject":{"$ref":"#/components/schemas/slides_v1_DeleteObjectRequest"},"deleteParagraphBullets":{"$ref":"#/components/schemas/slides_v1_DeleteParagraphBulletsRequest"},"deleteTableColumn":{"$ref":"#/components/schemas/slides_v1_DeleteTableColumnRequest"},"deleteTableRow":{"$ref":"#/components/schemas/slides_v1_DeleteTableRowRequest"},"deleteText":{"$ref":"#/components/schemas/slides_v1_DeleteTextRequest"},"duplicateObject":{"$ref":"#/components/schemas/slides_v1_DuplicateObjectRequest"},"groupObjects":{"$ref":"#/components/schemas/slides_v1_GroupObjectsRequest"},"insertComment":{"$ref":"#/components/schemas/slides_v1_InsertCommentRequest"},"insertTableColumns":{"$ref":"#/components/schemas/slides_v1_InsertTableColumnsRequest"},"insertTableRows":{"$ref":"#/components/schemas/slides_v1_InsertTableRowsRequest"},"insertText":{"$ref":"#/components/schemas/slides_v1_InsertTextRequest"},"mergeTableCells":{"$ref":"#/components/schemas/slides_v1_MergeTableCellsRequest"},"refreshSheetsChart":{"$ref":"#/components/schemas/slides_v1_RefreshSheetsChartRequest"},"replaceAllShapesWithImage":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithImageRequest"},"replaceAllShapesWithSheetsChart":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithSheetsChartRequest"},"replaceAllText":{"$ref":"#/components/schemas/slides_v1_ReplaceAllTextRequest"},"replaceImage":{"$ref":"#/components/schemas/slides_v1_ReplaceImageRequest"},"rerouteLine":{"$ref":"#/components/schemas/slides_v1_RerouteLineRequest"},"ungroupObjects":{"$ref":"#/components/schemas/slides_v1_UngroupObjectsRequest"},"unmergeTableCells":{"$ref":"#/components/schemas/slides_v1_UnmergeTableCellsRequest"},"updateCommentPost":{"$ref":"#/components/schemas/slides_v1_UpdateCommentPostRequest"},"updateImageProperties":{"$ref":"#/components/schemas/slides_v1_UpdateImagePropertiesRequest"},"updateLineCategory":{"$ref":"#/components/schemas/slides_v1_UpdateLineCategoryRequest"},"updateLineProperties":{"$ref":"#/components/schemas/slides_v1_UpdateLinePropertiesRequest"},"updatePageElementAltText":{"$ref":"#/components/schemas/slides_v1_UpdatePageElementAltTextRequest"},"updatePageElementTransform":{"$ref":"#/components/schemas/slides_v1_UpdatePageElementTransformRequest"},"updatePageElementsZOrder":{"$ref":"#/components/schemas/slides_v1_UpdatePageElementsZOrderRequest"},"updatePageProperties":{"$ref":"#/components/schemas/slides_v1_UpdatePagePropertiesRequest"},"updateParagraphStyle":{"$ref":"#/components/schemas/slides_v1_UpdateParagraphStyleRequest"},"updateShapeProperties":{"$ref":"#/components/schemas/slides_v1_UpdateShapePropertiesRequest"},"updateSlideProperties":{"$ref":"#/components/schemas/slides_v1_UpdateSlidePropertiesRequest"},"updateSlidesPosition":{"$ref":"#/components/schemas/slides_v1_UpdateSlidesPositionRequest"},"updateTableBorderProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableBorderPropertiesRequest"},"updateTableCellProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableCellPropertiesRequest"},"updateTableColumnProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableColumnPropertiesRequest"},"updateTableRowProperties":{"$ref":"#/components/schemas/slides_v1_UpdateTableRowPropertiesRequest"},"updateTextStyle":{"$ref":"#/components/schemas/slides_v1_UpdateTextStyleRequest"},"updateVideoProperties":{"$ref":"#/components/schemas/slides_v1_UpdateVideoPropertiesRequest"}}},"slides_v1_RerouteLineRequest":{"description":"Reroutes a line such that it's connected at the two closest connection sites on the connected page elements.","type":"object","properties":{"objectId":{"description":"The object ID of the line to reroute. Only a line with a category indicating it is a \"connector\" can be rerouted. The start and end connections of the line must be on different page elements.","type":"string"}}},"slides_v1_Response":{"description":"A single response from an update.","type":"object","properties":{"addCommentReply":{"$ref":"#/components/schemas/slides_v1_AddCommentReplyResponse"},"createImage":{"$ref":"#/components/schemas/slides_v1_CreateImageResponse"},"createLine":{"$ref":"#/components/schemas/slides_v1_CreateLineResponse"},"createShape":{"$ref":"#/components/schemas/slides_v1_CreateShapeResponse"},"createSheetsChart":{"$ref":"#/components/schemas/slides_v1_CreateSheetsChartResponse"},"createSlide":{"$ref":"#/components/schemas/slides_v1_CreateSlideResponse"},"createTable":{"$ref":"#/components/schemas/slides_v1_CreateTableResponse"},"createVideo":{"$ref":"#/components/schemas/slides_v1_CreateVideoResponse"},"duplicateObject":{"$ref":"#/components/schemas/slides_v1_DuplicateObjectResponse"},"groupObjects":{"$ref":"#/components/schemas/slides_v1_GroupObjectsResponse"},"insertComment":{"$ref":"#/components/schemas/slides_v1_InsertCommentResponse"},"replaceAllShapesWithImage":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithImageResponse"},"replaceAllShapesWithSheetsChart":{"$ref":"#/components/schemas/slides_v1_ReplaceAllShapesWithSheetsChartResponse"},"replaceAllText":{"$ref":"#/components/schemas/slides_v1_ReplaceAllTextResponse"}}},"slides_v1_RgbColor":{"description":"An RGB color.","type":"object","properties":{"blue":{"description":"The blue component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"green":{"description":"The green component of the color, from 0.0 to 1.0.","format":"float","type":"number"},"red":{"description":"The red component of the color, from 0.0 to 1.0.","format":"float","type":"number"}}},"slides_v1_Shadow":{"description":"The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind.","type":"object","properties":{"alignment":{"description":"The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only.","enum":["RECTANGLE_POSITION_UNSPECIFIED","TOP_LEFT","TOP_CENTER","TOP_RIGHT","LEFT_CENTER","CENTER","RIGHT_CENTER","BOTTOM_LEFT","BOTTOM_CENTER","BOTTOM_RIGHT"],"type":"string"},"alpha":{"description":"The alpha of the shadow's color, from 0.0 to 1.0.","format":"float","type":"number"},"blurRadius":{"$ref":"#/components/schemas/slides_v1_Dimension"},"color":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"},"propertyState":{"description":"The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"rotateWithShape":{"description":"Whether the shadow should rotate with the shape. This property is read-only.","type":"boolean"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"},"type":{"description":"The type of the shadow. This property is read-only.","enum":["SHADOW_TYPE_UNSPECIFIED","OUTER"],"type":"string"}}},"slides_v1_Shape":{"description":"A PageElement kind representing a generic shape that doesn't have a more specific classification. For more information, see [Size and position page elements](https://developers.google.com/workspace/slides/api/guides/transform).","type":"object","properties":{"placeholder":{"$ref":"#/components/schemas/slides_v1_Placeholder"},"shapeProperties":{"$ref":"#/components/schemas/slides_v1_ShapeProperties"},"shapeType":{"description":"The type of the shape.","enum":["TYPE_UNSPECIFIED","TEXT_BOX","RECTANGLE","ROUND_RECTANGLE","ELLIPSE","ARC","BENT_ARROW","BENT_UP_ARROW","BEVEL","BLOCK_ARC","BRACE_PAIR","BRACKET_PAIR","CAN","CHEVRON","CHORD","CLOUD","CORNER","CUBE","CURVED_DOWN_ARROW","CURVED_LEFT_ARROW","CURVED_RIGHT_ARROW","CURVED_UP_ARROW","DECAGON","DIAGONAL_STRIPE","DIAMOND","DODECAGON","DONUT","DOUBLE_WAVE","DOWN_ARROW","DOWN_ARROW_CALLOUT","FOLDED_CORNER","FRAME","HALF_FRAME","HEART","HEPTAGON","HEXAGON","HOME_PLATE","HORIZONTAL_SCROLL","IRREGULAR_SEAL_1","IRREGULAR_SEAL_2","LEFT_ARROW","LEFT_ARROW_CALLOUT","LEFT_BRACE","LEFT_BRACKET","LEFT_RIGHT_ARROW","LEFT_RIGHT_ARROW_CALLOUT","LEFT_RIGHT_UP_ARROW","LEFT_UP_ARROW","LIGHTNING_BOLT","MATH_DIVIDE","MATH_EQUAL","MATH_MINUS","MATH_MULTIPLY","MATH_NOT_EQUAL","MATH_PLUS","MOON","NO_SMOKING","NOTCHED_RIGHT_ARROW","OCTAGON","PARALLELOGRAM","PENTAGON","PIE","PLAQUE","PLUS","QUAD_ARROW","QUAD_ARROW_CALLOUT","RIBBON","RIBBON_2","RIGHT_ARROW","RIGHT_ARROW_CALLOUT","RIGHT_BRACE","RIGHT_BRACKET","ROUND_1_RECTANGLE","ROUND_2_DIAGONAL_RECTANGLE","ROUND_2_SAME_RECTANGLE","RIGHT_TRIANGLE","SMILEY_FACE","SNIP_1_RECTANGLE","SNIP_2_DIAGONAL_RECTANGLE","SNIP_2_SAME_RECTANGLE","SNIP_ROUND_RECTANGLE","STAR_10","STAR_12","STAR_16","STAR_24","STAR_32","STAR_4","STAR_5","STAR_6","STAR_7","STAR_8","STRIPED_RIGHT_ARROW","SUN","TRAPEZOID","TRIANGLE","UP_ARROW","UP_ARROW_CALLOUT","UP_DOWN_ARROW","UTURN_ARROW","VERTICAL_SCROLL","WAVE","WEDGE_ELLIPSE_CALLOUT","WEDGE_RECTANGLE_CALLOUT","WEDGE_ROUND_RECTANGLE_CALLOUT","FLOW_CHART_ALTERNATE_PROCESS","FLOW_CHART_COLLATE","FLOW_CHART_CONNECTOR","FLOW_CHART_DECISION","FLOW_CHART_DELAY","FLOW_CHART_DISPLAY","FLOW_CHART_DOCUMENT","FLOW_CHART_EXTRACT","FLOW_CHART_INPUT_OUTPUT","FLOW_CHART_INTERNAL_STORAGE","FLOW_CHART_MAGNETIC_DISK","FLOW_CHART_MAGNETIC_DRUM","FLOW_CHART_MAGNETIC_TAPE","FLOW_CHART_MANUAL_INPUT","FLOW_CHART_MANUAL_OPERATION","FLOW_CHART_MERGE","FLOW_CHART_MULTIDOCUMENT","FLOW_CHART_OFFLINE_STORAGE","FLOW_CHART_OFFPAGE_CONNECTOR","FLOW_CHART_ONLINE_STORAGE","FLOW_CHART_OR","FLOW_CHART_PREDEFINED_PROCESS","FLOW_CHART_PREPARATION","FLOW_CHART_PROCESS","FLOW_CHART_PUNCHED_CARD","FLOW_CHART_PUNCHED_TAPE","FLOW_CHART_SORT","FLOW_CHART_SUMMING_JUNCTION","FLOW_CHART_TERMINATOR","ARROW_EAST","ARROW_NORTH_EAST","ARROW_NORTH","SPEECH","STARBURST","TEARDROP","ELLIPSE_RIBBON","ELLIPSE_RIBBON_2","CLOUD_CALLOUT","CUSTOM"],"type":"string"},"text":{"$ref":"#/components/schemas/slides_v1_TextContent"}}},"slides_v1_ShapeBackgroundFill":{"description":"The shape background fill.","type":"object","properties":{"propertyState":{"description":"The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_ShapeProperties":{"description":"The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape.","type":"object","properties":{"autofit":{"$ref":"#/components/schemas/slides_v1_Autofit"},"contentAlignment":{"description":"The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor.","enum":["CONTENT_ALIGNMENT_UNSPECIFIED","CONTENT_ALIGNMENT_UNSUPPORTED","TOP","MIDDLE","BOTTOM"],"type":"string"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"shadow":{"$ref":"#/components/schemas/slides_v1_Shadow"},"shapeBackgroundFill":{"$ref":"#/components/schemas/slides_v1_ShapeBackgroundFill"}}},"slides_v1_ShapeTextAnchor":{"description":"An anchor to a specific range of text within a Shape's text. To insert comments in speaker notes, use the ShapeTextAnchor with the speaker notes object ID.","type":"object","properties":{"objectId":{"description":"The object ID of the page element containing the text.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_ShapeTextAnchors":{"description":"Represents text ranges within a shape covered by a comment anchor.","type":"object","properties":{"ranges":{"description":"A list of text ranges covered by the comment anchor.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TextRange"}}}},"slides_v1_SheetsChart":{"description":"A PageElement kind representing a linked chart embedded from Google Sheets.","type":"object","properties":{"chartId":{"description":"The ID of the specific chart in the Google Sheets spreadsheet that is embedded.","format":"int32","type":"integer"},"contentUrl":{"description":"The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change.","type":"string"},"sheetsChartProperties":{"$ref":"#/components/schemas/slides_v1_SheetsChartProperties"},"spreadsheetId":{"description":"The ID of the Google Sheets spreadsheet that contains the source chart.","type":"string"}}},"slides_v1_SheetsChartProperties":{"description":"The properties of the SheetsChart.","type":"object","properties":{"chartImageProperties":{"$ref":"#/components/schemas/slides_v1_ImageProperties"}}},"slides_v1_Size":{"description":"A width and height.","type":"object","properties":{"height":{"$ref":"#/components/schemas/slides_v1_Dimension"},"width":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_SlideProperties":{"description":"The properties of Page that are only relevant for pages with page_type SLIDE.","type":"object","properties":{"isSkipped":{"description":"Whether the slide is skipped in the presentation mode. Defaults to false.","type":"boolean"},"layoutObjectId":{"description":"The object ID of the layout that this slide is based on. This property is read-only.","type":"string"},"masterObjectId":{"description":"The object ID of the master that this slide is based on. This property is read-only.","type":"string"},"notesPage":{"$ref":"#/components/schemas/slides_v1_Page"}}},"slides_v1_SolidFill":{"description":"A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists.","type":"object","properties":{"alpha":{"description":"The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color.","format":"float","type":"number"},"color":{"$ref":"#/components/schemas/slides_v1_OpaqueColor"}}},"slides_v1_SpeakerSpotlight":{"description":"A PageElement kind representing a Speaker Spotlight.","type":"object","properties":{"speakerSpotlightProperties":{"$ref":"#/components/schemas/slides_v1_SpeakerSpotlightProperties"}}},"slides_v1_SpeakerSpotlightProperties":{"description":"The properties of the SpeakerSpotlight.","type":"object","properties":{"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"shadow":{"$ref":"#/components/schemas/slides_v1_Shadow"}}},"slides_v1_StretchedPictureFill":{"description":"The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.","type":"object","properties":{"contentUrl":{"description":"Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length.","type":"string"},"size":{"$ref":"#/components/schemas/slides_v1_Size"}}},"slides_v1_SubstringMatchCriteria":{"description":"A criteria that matches a specific string of text in a shape or table.","type":"object","properties":{"matchCase":{"description":"Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive.","type":"boolean"},"searchByRegex":{"description":"Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching.","type":"boolean"},"text":{"description":"The text to search for in the shape or table.","type":"string"}}},"slides_v1_Table":{"description":"A PageElement kind representing a table.","type":"object","properties":{"columns":{"description":"Number of columns in the table.","format":"int32","type":"integer"},"horizontalBorderRows":{"description":"Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableBorderRow"}},"rows":{"description":"Number of rows in the table.","format":"int32","type":"integer"},"tableColumns":{"description":"Properties of each column.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableColumnProperties"}},"tableRows":{"description":"Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableRow"}},"verticalBorderRows":{"description":"Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableBorderRow"}}}},"slides_v1_TableAnchor":{"description":"An anchor to a specific range of cells within a Table. Used to anchor a comment to all of the text in each cell in a range within a table.","type":"object","properties":{"objectId":{"description":"The object ID of the table.","type":"string"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_TableBorderCell":{"description":"The properties of each border cell.","type":"object","properties":{"location":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"tableBorderProperties":{"$ref":"#/components/schemas/slides_v1_TableBorderProperties"}}},"slides_v1_TableBorderFill":{"description":"The fill of the border.","type":"object","properties":{"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_TableBorderProperties":{"description":"The border styling properties of the TableBorderCell.","type":"object","properties":{"dashStyle":{"description":"The dash style of the border.","enum":["DASH_STYLE_UNSPECIFIED","SOLID","DOT","DASH","DASH_DOT","LONG_DASH","LONG_DASH_DOT"],"type":"string"},"tableBorderFill":{"$ref":"#/components/schemas/slides_v1_TableBorderFill"},"weight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_TableBorderRow":{"description":"Contents of each border row in a table.","type":"object","properties":{"tableBorderCells":{"description":"Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableBorderCell"}}}},"slides_v1_TableCell":{"description":"Properties and contents of each table cell.","type":"object","properties":{"columnSpan":{"description":"Column span of the cell.","format":"int32","type":"integer"},"location":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"rowSpan":{"description":"Row span of the cell.","format":"int32","type":"integer"},"tableCellProperties":{"$ref":"#/components/schemas/slides_v1_TableCellProperties"},"text":{"$ref":"#/components/schemas/slides_v1_TextContent"}}},"slides_v1_TableCellAnchors":{"description":"Represents table cell ranges within a table covered by a comment anchor.","type":"object","properties":{"cellRanges":{"description":"A list of all table cells in a table that have text covered by the anchor in the table.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableCellTextRanges"}}}},"slides_v1_TableCellBackgroundFill":{"description":"The table cell background fill.","type":"object","properties":{"propertyState":{"description":"The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored.","enum":["RENDERED","NOT_RENDERED","INHERIT"],"type":"string"},"solidFill":{"$ref":"#/components/schemas/slides_v1_SolidFill"}}},"slides_v1_TableCellLocation":{"description":"A location of a single table cell within a table.","type":"object","properties":{"columnIndex":{"description":"The 0-based column index.","format":"int32","type":"integer"},"rowIndex":{"description":"The 0-based row index.","format":"int32","type":"integer"}}},"slides_v1_TableCellProperties":{"description":"The properties of the TableCell.","type":"object","properties":{"contentAlignment":{"description":"The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor.","enum":["CONTENT_ALIGNMENT_UNSPECIFIED","CONTENT_ALIGNMENT_UNSUPPORTED","TOP","MIDDLE","BOTTOM"],"type":"string"},"tableCellBackgroundFill":{"$ref":"#/components/schemas/slides_v1_TableCellBackgroundFill"}}},"slides_v1_TableCellTextAnchor":{"description":"An anchor to a specific range of text within a TableCell's TextElement.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"objectId":{"description":"The object ID of the table containing the cell.","type":"string"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_TableCellTextRanges":{"description":"Represents text ranges within a table cell covered by a comment anchor.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"ranges":{"description":"A list of all text ranges covered by the anchor in this cell.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TextRange"}}}},"slides_v1_TableColumnProperties":{"description":"Properties of each column in a table.","type":"object","properties":{"columnWidth":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_TableRange":{"description":"A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]","type":"object","properties":{"columnSpan":{"description":"The column span of the table range.","format":"int32","type":"integer"},"location":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"rowSpan":{"description":"The row span of the table range.","format":"int32","type":"integer"}}},"slides_v1_TableRow":{"description":"Properties and contents of each row in a table.","type":"object","properties":{"rowHeight":{"$ref":"#/components/schemas/slides_v1_Dimension"},"tableCells":{"description":"Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TableCell"}},"tableRowProperties":{"$ref":"#/components/schemas/slides_v1_TableRowProperties"}}},"slides_v1_TableRowProperties":{"description":"Properties of each row in a table.","type":"object","properties":{"minRowHeight":{"$ref":"#/components/schemas/slides_v1_Dimension"}}},"slides_v1_TextContent":{"description":"The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page.","type":"object","properties":{"lists":{"description":"The bulleted lists contained in this text, keyed by list ID.","type":"object","additionalProperties":{"$ref":"#/components/schemas/slides_v1_List"}},"textElements":{"description":"The text contents broken down into its component parts, including styling information. This property is read-only.","type":"array","items":{"$ref":"#/components/schemas/slides_v1_TextElement"}}}},"slides_v1_TextElement":{"description":"A TextElement describes the content of a range of indices in the text content of a Shape or TableCell.","type":"object","properties":{"autoText":{"$ref":"#/components/schemas/slides_v1_AutoText"},"endIndex":{"description":"The zero-based end index of this text element, exclusive, in Unicode code units.","format":"int32","type":"integer"},"paragraphMarker":{"$ref":"#/components/schemas/slides_v1_ParagraphMarker"},"startIndex":{"description":"The zero-based start index of this text element, in Unicode code units.","format":"int32","type":"integer"},"textRun":{"$ref":"#/components/schemas/slides_v1_TextRun"}}},"slides_v1_TextRange":{"description":"Specifies a contiguous range of text within a shape or table cell's text.","type":"object","properties":{"endIndex":{"description":"The zero-based index of the end of the range. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"},"startIndex":{"description":"The zero-based index of the beginning range. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.","format":"int32","type":"integer"}}},"slides_v1_TextRun":{"description":"A TextElement kind that represents a run of text that all has the same styling.","type":"object","properties":{"content":{"description":"The text of this run.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_TextStyle"}}},"slides_v1_TextStyle":{"description":"Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor.","type":"object","properties":{"backgroundColor":{"$ref":"#/components/schemas/slides_v1_OptionalColor"},"baselineOffset":{"description":"The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field.","enum":["BASELINE_OFFSET_UNSPECIFIED","NONE","SUPERSCRIPT","SUBSCRIPT"],"type":"string"},"bold":{"description":"Whether or not the text is rendered as bold.","type":"boolean"},"fontFamily":{"description":"The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used.","type":"string"},"fontSize":{"$ref":"#/components/schemas/slides_v1_Dimension"},"foregroundColor":{"$ref":"#/components/schemas/slides_v1_OptionalColor"},"italic":{"description":"Whether or not the text is italicized.","type":"boolean"},"link":{"$ref":"#/components/schemas/slides_v1_Link"},"smallCaps":{"description":"Whether or not the text is in small capital letters.","type":"boolean"},"strikethrough":{"description":"Whether or not the text is struck through.","type":"boolean"},"underline":{"description":"Whether or not the text is underlined.","type":"boolean"},"weightedFontFamily":{"$ref":"#/components/schemas/slides_v1_WeightedFontFamily"}}},"slides_v1_ThemeColorPair":{"description":"A pair mapping a theme color type to the concrete color it represents.","type":"object","properties":{"color":{"$ref":"#/components/schemas/slides_v1_RgbColor"},"type":{"description":"The type of the theme color.","enum":["THEME_COLOR_TYPE_UNSPECIFIED","DARK1","LIGHT1","DARK2","LIGHT2","ACCENT1","ACCENT2","ACCENT3","ACCENT4","ACCENT5","ACCENT6","HYPERLINK","FOLLOWED_HYPERLINK","TEXT1","BACKGROUND1","TEXT2","BACKGROUND2"],"type":"string"}}},"slides_v1_Thumbnail":{"description":"The thumbnail of a page.","type":"object","properties":{"contentUrl":{"description":"The content URL of the thumbnail image. The URL to the image has a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. The mime type of the thumbnail image is the same as specified in the `GetPageThumbnailRequest`.","type":"string"},"height":{"description":"The positive height in pixels of the thumbnail image.","format":"int32","type":"integer"},"width":{"description":"The positive width in pixels of the thumbnail image.","format":"int32","type":"integer"}}},"slides_v1_UngroupObjectsRequest":{"description":"Ungroups objects, such as groups.","type":"object","properties":{"objectIds":{"description":"The object IDs of the objects to ungroup. Only groups that are not inside other groups can be ungrouped. All the groups should be on the same page. The group itself is deleted. The visual sizes and positions of all the children are preserved.","type":"array","items":{"type":"string"}}}},"slides_v1_UnmergeTableCellsRequest":{"description":"Unmerges cells in a Table.","type":"object","properties":{"objectId":{"description":"The object ID of the table.","type":"string"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_UpdateCommentPostRequest":{"description":"Updates a Post in a CommentThread. Returns a 400 bad request error if: - The requesting user is not the author of the post.","type":"object","properties":{"commentId":{"description":"The ID of the CommentThread which the post belongs to.","type":"string"},"content":{"description":"The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Slides editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units.","type":"string"},"postId":{"description":"The ID of the post being updated.","type":"string"}}},"slides_v1_UpdateImagePropertiesRequest":{"description":"Update the properties of an Image.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `imageProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the image outline color, set `fields` to `\"outline.outlineFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"imageProperties":{"$ref":"#/components/schemas/slides_v1_ImageProperties"},"objectId":{"description":"The object ID of the image the updates are applied to.","type":"string"}}},"slides_v1_UpdateLineCategoryRequest":{"description":"Updates the category of a line.","type":"object","properties":{"lineCategory":{"description":"The line category to update to. The exact line type is determined based on the category to update to and how it's routed to connect to other page elements.","enum":["LINE_CATEGORY_UNSPECIFIED","STRAIGHT","BENT","CURVED"],"type":"string"},"objectId":{"description":"The object ID of the line the update is applied to. Only a line with a category indicating it is a \"connector\" can be updated. The line may be rerouted after updating its category.","type":"string"}}},"slides_v1_UpdateLinePropertiesRequest":{"description":"Updates the properties of a Line.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `lineProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the line solid fill color, set `fields` to `\"lineFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"lineProperties":{"$ref":"#/components/schemas/slides_v1_LineProperties"},"objectId":{"description":"The object ID of the line the update is applied to.","type":"string"}}},"slides_v1_UpdatePageElementAltTextRequest":{"description":"Updates the alt text title and/or description of a page element.","type":"object","properties":{"description":{"description":"The updated alt text description of the page element. If unset the existing value will be maintained. The description is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.","type":"string"},"objectId":{"description":"The object ID of the page element the updates are applied to.","type":"string"},"title":{"description":"The updated alt text title of the page element. If unset the existing value will be maintained. The title is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.","type":"string"}}},"slides_v1_UpdatePageElementTransformRequest":{"description":"Updates the transform of a page element. Updating the transform of a group will change the absolute transform of the page elements in that group, which can change their visual appearance. See the documentation for PageElement.transform for more details.","type":"object","properties":{"applyMode":{"description":"The apply mode of the transform update.","enum":["APPLY_MODE_UNSPECIFIED","RELATIVE","ABSOLUTE"],"type":"string"},"objectId":{"description":"The object ID of the page element to update.","type":"string"},"transform":{"$ref":"#/components/schemas/slides_v1_AffineTransform"}}},"slides_v1_UpdatePageElementsZOrderRequest":{"description":"Updates the Z-order of page elements. Z-order is an ordering of the elements on the page from back to front. The page element in the front may cover the elements that are behind it.","type":"object","properties":{"operation":{"description":"The Z-order operation to apply on the page elements. When applying the operation on multiple page elements, the relative Z-orders within these page elements before the operation is maintained.","enum":["Z_ORDER_OPERATION_UNSPECIFIED","BRING_TO_FRONT","BRING_FORWARD","SEND_BACKWARD","SEND_TO_BACK"],"type":"string"},"pageElementObjectIds":{"description":"The object IDs of the page elements to update. All the page elements must be on the same page and must not be grouped.","type":"array","items":{"type":"string"}}}},"slides_v1_UpdatePagePropertiesRequest":{"description":"Updates the properties of a Page.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `pageProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the page background solid fill color, set `fields` to `\"pageBackgroundFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the page the update is applied to.","type":"string"},"pageProperties":{"$ref":"#/components/schemas/slides_v1_PageProperties"}}},"slides_v1_UpdateParagraphStyleRequest":{"description":"Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the paragraph alignment, set `fields` to `\"alignment\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the shape or table with the text to be styled.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_ParagraphStyle"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_UpdateShapePropertiesRequest":{"description":"Update the properties of a Shape.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `shapeProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the shape background solid fill color, set `fields` to `\"shapeBackgroundFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the shape the updates are applied to.","type":"string"},"shapeProperties":{"$ref":"#/components/schemas/slides_v1_ShapeProperties"}}},"slides_v1_UpdateSlidePropertiesRequest":{"description":"Updates the properties of a Slide.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root 'slideProperties' is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update whether a slide is skipped, set `fields` to `\"isSkipped\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the slide the update is applied to.","type":"string"},"slideProperties":{"$ref":"#/components/schemas/slides_v1_SlideProperties"}}},"slides_v1_UpdateSlidesPositionRequest":{"description":"Updates the position of slides in the presentation.","type":"object","properties":{"insertionIndex":{"description":"The index where the slides should be inserted, based on the slide arrangement before the move takes place. Must be between zero and the number of slides in the presentation, inclusive.","format":"int32","type":"integer"},"slideObjectIds":{"description":"The IDs of the slides in the presentation that should be moved. The slides in this list must be in existing presentation order, without duplicates.","type":"array","items":{"type":"string"}}}},"slides_v1_UpdateTableBorderPropertiesRequest":{"description":"Updates the properties of the table borders in a Table.","type":"object","properties":{"borderPosition":{"description":"The border position in the table range the updates should apply to. If a border position is not specified, the updates will apply to all borders in the table range.","enum":["ALL","BOTTOM","INNER","INNER_HORIZONTAL","INNER_VERTICAL","LEFT","OUTER","RIGHT","TOP"],"type":"string"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableBorderProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the table border solid fill color, set `fields` to `\"tableBorderFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"tableBorderProperties":{"$ref":"#/components/schemas/slides_v1_TableBorderProperties"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_UpdateTableCellPropertiesRequest":{"description":"Update the properties of a TableCell.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableCellProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the table cell background solid fill color, set `fields` to `\"tableCellBackgroundFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"tableCellProperties":{"$ref":"#/components/schemas/slides_v1_TableCellProperties"},"tableRange":{"$ref":"#/components/schemas/slides_v1_TableRange"}}},"slides_v1_UpdateTableColumnPropertiesRequest":{"description":"Updates the properties of a Table column.","type":"object","properties":{"columnIndices":{"description":"The list of zero-based indices specifying which columns to update. If no indices are provided, all columns in the table will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `\"column_width\"`. If '\"column_width\"' is included in the field mask but the property is left unset, the column width will default to 406,400 EMU (32 points).","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"tableColumnProperties":{"$ref":"#/components/schemas/slides_v1_TableColumnProperties"}}},"slides_v1_UpdateTableRowPropertiesRequest":{"description":"Updates the properties of a Table row.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `tableRowProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `\"min_row_height\"`. If '\"min_row_height\"' is included in the field mask but the property is left unset, the minimum row height will default to 0.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the table.","type":"string"},"rowIndices":{"description":"The list of zero-based indices specifying which rows to update. If no indices are provided, all rows in the table will be updated.","type":"array","items":{"format":"int32","type":"integer"}},"tableRowProperties":{"$ref":"#/components/schemas/slides_v1_TableRowProperties"}}},"slides_v1_UpdateTextStyleRequest":{"description":"Update the styling of text in a Shape or Table.","type":"object","properties":{"cellLocation":{"$ref":"#/components/schemas/slides_v1_TableCellLocation"},"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `\"bold\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the shape or table with the text to be styled.","type":"string"},"style":{"$ref":"#/components/schemas/slides_v1_TextStyle"},"textRange":{"$ref":"#/components/schemas/slides_v1_Range"}}},"slides_v1_UpdateVideoPropertiesRequest":{"description":"Update the properties of a Video.","type":"object","properties":{"fields":{"description":"The fields that should be updated. At least one field must be specified. The root `videoProperties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the video outline color, set `fields` to `\"outline.outlineFill.solidFill.color\"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.","format":"google-fieldmask","type":"string"},"objectId":{"description":"The object ID of the video the updates are applied to.","type":"string"},"videoProperties":{"$ref":"#/components/schemas/slides_v1_VideoProperties"}}},"slides_v1_Video":{"description":"A PageElement kind representing a video.","type":"object","properties":{"id":{"description":"The video source's unique identifier for this video.","type":"string"},"source":{"description":"The video source.","enum":["SOURCE_UNSPECIFIED","YOUTUBE","DRIVE"],"type":"string"},"url":{"description":"An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change.","type":"string"},"videoProperties":{"$ref":"#/components/schemas/slides_v1_VideoProperties"}}},"slides_v1_VideoProperties":{"description":"The properties of the Video.","type":"object","properties":{"autoPlay":{"description":"Whether to enable video autoplay when the page is displayed in present mode. Defaults to false.","type":"boolean"},"end":{"description":"The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end.","format":"uint32","type":"integer"},"mute":{"description":"Whether to mute the audio during video playback. Defaults to false.","type":"boolean"},"outline":{"$ref":"#/components/schemas/slides_v1_Outline"},"start":{"description":"The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning.","format":"uint32","type":"integer"}}},"slides_v1_WeightedFontFamily":{"description":"Represents a font family and weight used to style a TextRun.","type":"object","properties":{"fontFamily":{"description":"The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.","type":"string"},"weight":{"description":"The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` (\"normal\").","format":"int32","type":"integer"}}},"slides_v1_WordArt":{"description":"A PageElement kind representing word art.","type":"object","properties":{"renderedText":{"description":"The text rendered as word art.","type":"string"}}},"slides_v1_WriteControl":{"description":"Provides control over how write requests are executed.","type":"object","properties":{"requiredRevisionId":{"description":"The revision ID of the presentation required for the write request. If specified and the required revision ID doesn't match the presentation's current revision ID, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/presentations":"See, edit, create, and delete all your Google Slides presentations","https://www.googleapis.com/auth/presentations.readonly":"See all your Google Slides presentations"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/presentations"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/slides/v1/rest","service":"slides","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-tasks.json b/public/specs/google/google-tasks.json index 91201213..f1379589 100644 --- a/public/specs/google/google-tasks.json +++ b/public/specs/google/google-tasks.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"Google Tasks API","version":"v1","description":"The Google Tasks API lets you manage your tasks and task lists."},"servers":[{"url":"https://tasks.googleapis.com/"}],"paths":{"/tasks/v1/lists/{tasklist}/clear":{"post":{"operationId":"tasks.tasks.clear","x-executor-toolPath":"tasks.tasks.clear","tags":["Google Tasks API"],"description":"Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/lists/{tasklist}/tasks":{"get":{"operationId":"tasks.tasks.list","x-executor-toolPath":"tasks.tasks.list","tags":["Google Tasks API"],"description":"Returns all tasks in the specified task list. Doesn't return assigned tasks by default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"completedMax","in":"query","required":false,"description":"Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","schema":{"description":"Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","type":"string"},"style":"form","explode":false},{"name":"completedMin","in":"query","required":false,"description":"Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","schema":{"description":"Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","type":"string"},"style":"form","explode":false},{"name":"dueMax","in":"query","required":false,"description":"Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","schema":{"description":"Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","type":"string"},"style":"form","explode":false},{"name":"dueMin","in":"query","required":false,"description":"Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","schema":{"description":"Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100).","schema":{"description":"Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100).","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying the result page to return. Optional.","schema":{"description":"Token specifying the result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showAssigned","in":"query","required":false,"description":"Optional. Flag indicating whether tasks assigned to the current user are returned in the result. Optional. The default is False.","schema":{"description":"Optional. Flag indicating whether tasks assigned to the current user are returned in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showCompleted","in":"query","required":false,"description":"Flag indicating whether completed tasks are returned in the result. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps. Optional. The default is True.","schema":{"description":"Flag indicating whether completed tasks are returned in the result. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.","schema":{"description":"Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHidden","in":"query","required":false,"description":"Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.","schema":{"description":"Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"updatedMin","in":"query","required":false,"description":"Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.","schema":{"description":"Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Tasks"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"post":{"operationId":"tasks.tasks.insert","x-executor-toolPath":"tasks.tasks.insert","tags":["Google Tasks API"],"description":"Creates a new task on the specified task list. Tasks assigned from Docs or Chat Spaces cannot be inserted from Tasks Public API; they can only be created by assigning them from Docs or Chat Spaces. A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. Optional.","schema":{"description":"Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"previous","in":"query","required":false,"description":"Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.","schema":{"description":"Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/lists/{tasklist}/tasks/{task}":{"get":{"operationId":"tasks.tasks.get","x-executor-toolPath":"tasks.tasks.get","tags":["Google Tasks API"],"description":"Returns the specified task.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"put":{"operationId":"tasks.tasks.update","x-executor-toolPath":"tasks.tasks.update","tags":["Google Tasks API"],"description":"Updates the specified task.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"delete":{"operationId":"tasks.tasks.delete","x-executor-toolPath":"tasks.tasks.delete","tags":["Google Tasks API"],"description":"Deletes the specified task from the task list. If the task is assigned, both the assigned task and the original task (in Docs, Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"patch":{"operationId":"tasks.tasks.patch","x-executor-toolPath":"tasks.tasks.patch","tags":["Google Tasks API"],"description":"Updates the specified task. This method supports patch semantics.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/lists/{tasklist}/tasks/{task}/move":{"post":{"operationId":"tasks.tasks.move","x-executor-toolPath":"tasks.tasks.move","tags":["Google Tasks API"],"description":"Moves the specified task to another position in the destination task list. If the destination list is not specified, the task is moved within its current list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. A user can have up to 2,000 subtasks per task.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"destinationTasklist","in":"query","required":false,"description":"Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists.","schema":{"description":"Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned and repeating tasks cannot be set as parent tasks (have subtasks), or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty.","schema":{"description":"Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned and repeating tasks cannot be set as parent tasks (have subtasks), or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"previous","in":"query","required":false,"description":"Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Exceptions: 1. Tasks that are both completed and hidden can only be moved to position 0, so the previous field must be empty.","schema":{"description":"Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Exceptions: 1. Tasks that are both completed and hidden can only be moved to position 0, so the previous field must be empty.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/users/@me/lists":{"get":{"operationId":"tasks.tasklists.list","x-executor-toolPath":"tasks.tasklists.list","tags":["Google Tasks API"],"description":"Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000).","schema":{"description":"Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000).","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying the result page to return. Optional.","schema":{"description":"Token specifying the result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskLists"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"post":{"operationId":"tasks.tasklists.insert","x-executor-toolPath":"tasks.tasklists.insert","tags":["Google Tasks API"],"description":"Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/users/@me/lists/{tasklist}":{"get":{"operationId":"tasks.tasklists.get","x-executor-toolPath":"tasks.tasklists.get","tags":["Google Tasks API"],"description":"Returns the authenticated user's specified task list.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"put":{"operationId":"tasks.tasklists.update","x-executor-toolPath":"tasks.tasklists.update","tags":["Google Tasks API"],"description":"Updates the authenticated user's specified task list.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"delete":{"operationId":"tasks.tasklists.delete","x-executor-toolPath":"tasks.tasklists.delete","tags":["Google Tasks API"],"description":"Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"patch":{"operationId":"tasks.tasklists.patch","x-executor-toolPath":"tasks.tasklists.patch","tags":["Google Tasks API"],"description":"Updates the authenticated user's specified task list. This method supports patch semantics.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}}},"components":{"schemas":{"tasks_v1_AssignmentInfo":{"description":"Information about the source of the task assignment (Document, Chat Space).","type":"object","properties":{"driveResourceInfo":{"$ref":"#/components/schemas/tasks_v1_DriveResourceInfo"},"linkToTask":{"description":"Output only. An absolute link to the original task in the surface of assignment (Docs, Chat spaces, etc.).","readOnly":true,"type":"string"},"spaceInfo":{"$ref":"#/components/schemas/tasks_v1_SpaceInfo"},"surfaceType":{"description":"Output only. The type of surface this assigned task originates from. Currently limited to DOCUMENT or SPACE.","readOnly":true,"enum":["CONTEXT_TYPE_UNSPECIFIED","GMAIL","DOCUMENT","SPACE"],"type":"string"}}},"tasks_v1_DriveResourceInfo":{"description":"Information about the Drive resource where a task was assigned from (the document, sheet, etc.).","type":"object","properties":{"driveFileId":{"description":"Output only. Identifier of the file in the Drive API.","readOnly":true,"type":"string"},"resourceKey":{"description":"Output only. Resource key required to access files shared via a shared link. Not required for all files. See also developers.google.com/drive/api/guides/resource-keys.","readOnly":true,"type":"string"}}},"tasks_v1_SpaceInfo":{"description":"Information about the Chat Space where a task was assigned from.","type":"object","properties":{"space":{"description":"Output only. The Chat space where this task originates from. The format is \"spaces/{space}\".","readOnly":true,"type":"string"}}},"tasks_v1_Task":{"type":"object","properties":{"assignmentInfo":{"$ref":"#/components/schemas/tasks_v1_AssignmentInfo"},"completed":{"description":"Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.","type":"string"},"deleted":{"description":"Flag indicating whether the task has been deleted. For assigned tasks this field is read-only. They can only be deleted by calling tasks.delete, in which case both the assigned task and the original task (in Docs or Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there. The default is False.","type":"boolean"},"due":{"description":"Scheduled date for the task (as an RFC 3339 timestamp). Optional. This represents the day that the task should be done, or that the task is visible on the calendar grid. It doesn't represent the deadline of the task. Only date information is recorded; the time portion of the timestamp is discarded when setting this field. It isn't possible to read or write the time that a task is scheduled for using the API.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"hidden":{"description":"Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.","type":"boolean"},"id":{"description":"Task identifier.","type":"string"},"kind":{"description":"Output only. Type of the resource. This is always \"tasks#task\".","readOnly":true,"type":"string"},"links":{"description":"Output only. Collection of links. This collection is read-only.","readOnly":true,"type":"array","items":{"type":"object","properties":{"description":{"description":"The description (might be empty).","type":"string"},"link":{"description":"The URL.","type":"string"},"type":{"description":"Type of the link, e.g. \"email\", \"generic\", \"chat_message\", \"keep_note\".","type":"string"}}}},"notes":{"description":"Notes describing the task. Tasks assigned from Google Docs cannot have notes. Optional. Maximum length allowed: 8192 characters.","type":"string"},"parent":{"description":"Output only. Parent task identifier. This field is omitted if it is a top-level task. Use the \"move\" method to move the task under a different parent or to the top level. A parent task can never be an assigned task (from Chat Spaces, Docs). This field is read-only.","readOnly":true,"type":"string"},"position":{"description":"Output only. String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). Use the \"move\" method to move the task to another position.","readOnly":true,"type":"string"},"selfLink":{"description":"Output only. URL pointing to this task. Used to retrieve, update, or delete this task.","readOnly":true,"type":"string"},"status":{"description":"Status of the task. This is either \"needsAction\" or \"completed\".","type":"string"},"title":{"description":"Title of the task. Maximum length allowed: 1024 characters.","type":"string"},"updated":{"description":"Output only. Last modification time of the task (as a RFC 3339 timestamp).","readOnly":true,"type":"string"},"webViewLink":{"description":"Output only. An absolute link to the task in the Google Tasks Web UI.","readOnly":true,"type":"string"}}},"tasks_v1_TaskList":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"Task list identifier.","type":"string"},"kind":{"description":"Output only. Type of the resource. This is always \"tasks#taskList\".","readOnly":true,"type":"string"},"selfLink":{"description":"Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.","readOnly":true,"type":"string"},"title":{"description":"Title of the task list. Maximum length allowed: 1024 characters.","type":"string"},"updated":{"description":"Output only. Last modification time of the task list (as a RFC 3339 timestamp).","readOnly":true,"type":"string"}}},"tasks_v1_TaskLists":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"Collection of task lists.","type":"array","items":{"$ref":"#/components/schemas/tasks_v1_TaskList"}},"kind":{"description":"Type of the resource. This is always \"tasks#taskLists\".","type":"string"},"nextPageToken":{"description":"Token that can be used to request the next page of this result.","type":"string"}}},"tasks_v1_Tasks":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"Collection of tasks.","type":"array","items":{"$ref":"#/components/schemas/tasks_v1_Task"}},"kind":{"description":"Type of the resource. This is always \"tasks#tasks\".","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/tasks":""}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/tasks"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/tasks/v1/rest","service":"tasks","version":"v1"}]}} \ No newline at end of file +{"openapi":"3.1.0","info":{"title":"Google Tasks API","version":"v1","description":"The Google Tasks API lets you manage your tasks and task lists."},"servers":[{"url":"https://tasks.googleapis.com/"}],"paths":{"/tasks/v1/lists/{tasklist}/clear":{"post":{"operationId":"tasks.tasks.clear","x-executor-toolPath":"tasks.tasks.clear","tags":["Google Tasks API"],"description":"Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/lists/{tasklist}/tasks":{"get":{"operationId":"tasks.tasks.list","x-executor-toolPath":"tasks.tasks.list","tags":["Google Tasks API"],"description":"Returns all tasks in the specified task list. Doesn't return assigned tasks by default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"completedMax","in":"query","required":false,"description":"Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","schema":{"description":"Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","type":"string"},"style":"form","explode":false},{"name":"completedMin","in":"query","required":false,"description":"Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","schema":{"description":"Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.","type":"string"},"style":"form","explode":false},{"name":"dueMax","in":"query","required":false,"description":"Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","schema":{"description":"Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","type":"string"},"style":"form","explode":false},{"name":"dueMin","in":"query","required":false,"description":"Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","schema":{"description":"Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100).","schema":{"description":"Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100).","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying the result page to return. Optional.","schema":{"description":"Token specifying the result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"showAssigned","in":"query","required":false,"description":"Optional. Flag indicating whether tasks assigned to the current user are returned in the result. Optional. The default is False.","schema":{"description":"Optional. Flag indicating whether tasks assigned to the current user are returned in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showCompleted","in":"query","required":false,"description":"Flag indicating whether completed tasks are returned in the result. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps. Optional. The default is True.","schema":{"description":"Flag indicating whether completed tasks are returned in the result. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps. Optional. The default is True.","type":"boolean"},"style":"form","explode":false},{"name":"showDeleted","in":"query","required":false,"description":"Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.","schema":{"description":"Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"showHidden","in":"query","required":false,"description":"Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.","schema":{"description":"Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.","type":"boolean"},"style":"form","explode":false},{"name":"updatedMin","in":"query","required":false,"description":"Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.","schema":{"description":"Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Tasks"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks.readonly","https://www.googleapis.com/auth/tasks"]},"post":{"operationId":"tasks.tasks.insert","x-executor-toolPath":"tasks.tasks.insert","tags":["Google Tasks API"],"description":"Creates a new task on the specified task list. Tasks assigned from Docs or Chat Spaces cannot be inserted from Tasks Public API; they can only be created by assigning them from Docs or Chat Spaces. A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. Optional.","schema":{"description":"Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"previous","in":"query","required":false,"description":"Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.","schema":{"description":"Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/lists/{tasklist}/tasks/{task}":{"get":{"operationId":"tasks.tasks.get","x-executor-toolPath":"tasks.tasks.get","tags":["Google Tasks API"],"description":"Returns the specified task.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks.readonly","https://www.googleapis.com/auth/tasks"]},"put":{"operationId":"tasks.tasks.update","x-executor-toolPath":"tasks.tasks.update","tags":["Google Tasks API"],"description":"Updates the specified task.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"delete":{"operationId":"tasks.tasks.delete","x-executor-toolPath":"tasks.tasks.delete","tags":["Google Tasks API"],"description":"Deletes the specified task from the task list. If the task is assigned, both the assigned task and the original task (in Docs, Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"patch":{"operationId":"tasks.tasks.patch","x-executor-toolPath":"tasks.tasks.patch","tags":["Google Tasks API"],"description":"Updates the specified task. This method supports patch semantics.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/lists/{tasklist}/tasks/{task}/move":{"post":{"operationId":"tasks.tasks.move","x-executor-toolPath":"tasks.tasks.move","tags":["Google Tasks API"],"description":"Moves the specified task to another position in the destination task list. If the destination list is not specified, the task is moved within its current list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. A user can have up to 2,000 subtasks per task.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"task","in":"path","required":true,"description":"Task identifier.","schema":{"description":"Task identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"destinationTasklist","in":"query","required":false,"description":"Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists.","schema":{"description":"Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned and repeating tasks cannot be set as parent tasks (have subtasks), or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty.","schema":{"description":"Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned and repeating tasks cannot be set as parent tasks (have subtasks), or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"previous","in":"query","required":false,"description":"Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Exceptions: 1. Tasks that are both completed and hidden can only be moved to position 0, so the previous field must be empty.","schema":{"description":"Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Exceptions: 1. Tasks that are both completed and hidden can only be moved to position 0, so the previous field must be empty.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_Task"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/users/@me/lists":{"get":{"operationId":"tasks.tasklists.list","x-executor-toolPath":"tasks.tasklists.list","tags":["Google Tasks API"],"description":"Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000).","schema":{"description":"Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000).","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"Token specifying the result page to return. Optional.","schema":{"description":"Token specifying the result page to return. Optional.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskLists"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks.readonly","https://www.googleapis.com/auth/tasks"]},"post":{"operationId":"tasks.tasklists.insert","x-executor-toolPath":"tasks.tasklists.insert","tags":["Google Tasks API"],"description":"Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}},"/tasks/v1/users/@me/lists/{tasklist}":{"get":{"operationId":"tasks.tasklists.get","x-executor-toolPath":"tasks.tasklists.get","tags":["Google Tasks API"],"description":"Returns the authenticated user's specified task list.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks.readonly"]},{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks.readonly","https://www.googleapis.com/auth/tasks"]},"put":{"operationId":"tasks.tasklists.update","x-executor-toolPath":"tasks.tasklists.update","tags":["Google Tasks API"],"description":"Updates the authenticated user's specified task list.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"delete":{"operationId":"tasks.tasklists.delete","x-executor-toolPath":"tasks.tasklists.delete","tags":["Google Tasks API"],"description":"Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]},"patch":{"operationId":"tasks.tasklists.patch","x-executor-toolPath":"tasks.tasklists.patch","tags":["Google Tasks API"],"description":"Updates the authenticated user's specified task list. This method supports patch semantics.","parameters":[{"name":"tasklist","in":"path","required":true,"description":"Task list identifier.","schema":{"description":"Task list identifier.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_v1_TaskList"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/tasks"]}],"x-google-scopes":["https://www.googleapis.com/auth/tasks"]}}},"components":{"schemas":{"tasks_v1_AssignmentInfo":{"description":"Information about the source of the task assignment (Document, Chat Space).","type":"object","properties":{"driveResourceInfo":{"$ref":"#/components/schemas/tasks_v1_DriveResourceInfo"},"linkToTask":{"description":"Output only. An absolute link to the original task in the surface of assignment (Docs, Chat spaces, etc.).","readOnly":true,"type":"string"},"spaceInfo":{"$ref":"#/components/schemas/tasks_v1_SpaceInfo"},"surfaceType":{"description":"Output only. The type of surface this assigned task originates from. Currently limited to DOCUMENT or SPACE.","readOnly":true,"enum":["CONTEXT_TYPE_UNSPECIFIED","GMAIL","DOCUMENT","SPACE"],"type":"string"}}},"tasks_v1_DriveResourceInfo":{"description":"Information about the Drive resource where a task was assigned from (the document, sheet, etc.).","type":"object","properties":{"driveFileId":{"description":"Output only. Identifier of the file in the Drive API.","readOnly":true,"type":"string"},"resourceKey":{"description":"Output only. Resource key required to access files shared via a shared link. Not required for all files. See also developers.google.com/drive/api/guides/resource-keys.","readOnly":true,"type":"string"}}},"tasks_v1_SpaceInfo":{"description":"Information about the Chat Space where a task was assigned from.","type":"object","properties":{"space":{"description":"Output only. The Chat space where this task originates from. The format is \"spaces/{space}\".","readOnly":true,"type":"string"}}},"tasks_v1_Task":{"type":"object","properties":{"assignmentInfo":{"$ref":"#/components/schemas/tasks_v1_AssignmentInfo"},"completed":{"description":"Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.","type":"string"},"deleted":{"description":"Flag indicating whether the task has been deleted. For assigned tasks this field is read-only. They can only be deleted by calling tasks.delete, in which case both the assigned task and the original task (in Docs or Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there. The default is False.","type":"boolean"},"due":{"description":"Scheduled date for the task (as an RFC 3339 timestamp). Optional. This represents the day that the task should be done, or that the task is visible on the calendar grid. It doesn't represent the deadline of the task. Only date information is recorded; the time portion of the timestamp is discarded when setting this field. It isn't possible to read or write the time that a task is scheduled for using the API.","type":"string"},"etag":{"description":"ETag of the resource.","type":"string"},"hidden":{"description":"Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.","type":"boolean"},"id":{"description":"Task identifier.","type":"string"},"kind":{"description":"Output only. Type of the resource. This is always \"tasks#task\".","readOnly":true,"type":"string"},"links":{"description":"Output only. Collection of links. This collection is read-only.","readOnly":true,"type":"array","items":{"type":"object","properties":{"description":{"description":"The description (might be empty).","type":"string"},"link":{"description":"The URL.","type":"string"},"type":{"description":"Type of the link, e.g. \"email\", \"generic\", \"chat_message\", \"keep_note\".","type":"string"}}}},"notes":{"description":"Notes describing the task. Tasks assigned from Google Docs cannot have notes. Optional. Maximum length allowed: 8192 characters.","type":"string"},"parent":{"description":"Output only. Parent task identifier. This field is omitted if it is a top-level task. Use the \"move\" method to move the task under a different parent or to the top level. A parent task can never be an assigned task (from Chat Spaces, Docs). This field is read-only.","readOnly":true,"type":"string"},"position":{"description":"Output only. String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). Use the \"move\" method to move the task to another position.","readOnly":true,"type":"string"},"selfLink":{"description":"Output only. URL pointing to this task. Used to retrieve, update, or delete this task.","readOnly":true,"type":"string"},"status":{"description":"Status of the task. This is either \"needsAction\" or \"completed\".","type":"string"},"title":{"description":"Title of the task. Maximum length allowed: 1024 characters.","type":"string"},"updated":{"description":"Output only. Last modification time of the task (as a RFC 3339 timestamp).","readOnly":true,"type":"string"},"webViewLink":{"description":"Output only. An absolute link to the task in the Google Tasks Web UI.","readOnly":true,"type":"string"}}},"tasks_v1_TaskList":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"id":{"description":"Task list identifier.","type":"string"},"kind":{"description":"Output only. Type of the resource. This is always \"tasks#taskList\".","readOnly":true,"type":"string"},"selfLink":{"description":"Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.","readOnly":true,"type":"string"},"title":{"description":"Title of the task list. Maximum length allowed: 1024 characters.","type":"string"},"updated":{"description":"Output only. Last modification time of the task list (as a RFC 3339 timestamp).","readOnly":true,"type":"string"}}},"tasks_v1_TaskLists":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"Collection of task lists.","type":"array","items":{"$ref":"#/components/schemas/tasks_v1_TaskList"}},"kind":{"description":"Type of the resource. This is always \"tasks#taskLists\".","type":"string"},"nextPageToken":{"description":"Token that can be used to request the next page of this result.","type":"string"}}},"tasks_v1_Tasks":{"type":"object","properties":{"etag":{"description":"ETag of the resource.","type":"string"},"items":{"description":"Collection of tasks.","type":"array","items":{"$ref":"#/components/schemas/tasks_v1_Task"}},"kind":{"description":"Type of the resource. This is always \"tasks#tasks\".","type":"string"},"nextPageToken":{"description":"Token used to access the next page of this result.","type":"string"}}}},"securitySchemes":{"googleOAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.google.com/o/oauth2/v2/auth","tokenUrl":"https://oauth2.googleapis.com/token","scopes":{"openid":"","email":"","profile":"","https://www.googleapis.com/auth/tasks":"Create, edit, organize, and delete all your tasks","https://www.googleapis.com/auth/tasks.readonly":"View your tasks"}}}}}},"security":[{"googleOAuth2":["openid","email","profile","https://www.googleapis.com/auth/tasks"]}],"x-executor-origin":{"kind":"googleDiscoveryBundle","services":[{"discoveryUrl":"https://www.googleapis.com/discovery/v1/apis/tasks/v1/rest","service":"tasks","version":"v1"}]}} \ No newline at end of file diff --git a/public/specs/google/google-youtube-data.json b/public/specs/google/google-youtube-data.json index c46edcf3..8e6c4809 100644 --- a/public/specs/google/google-youtube-data.json +++ b/public/specs/google/google-youtube-data.json @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"YouTube Data API v3","version":"v3","description":"The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels."},"servers":[{"url":"https://youtube.googleapis.com/"}],"paths":{"/upload/youtube/v3/captions":{"put":{"operationId":"youtube.captions.updateMedia","x-executor-toolPath":"youtube.captions.updateMedia","tags":["YouTube Data API v3"],"description":"Updates an existing resource. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"onBehalfOf","in":"query","required":false,"description":"ID of the Google+ Page for the channel that the request is on behalf of.","schema":{"description":"ID of the Google+ Page for the channel that the request is on behalf of.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sync","in":"query","required":false,"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","schema":{"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Caption"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.captions.insertMedia","x-executor-toolPath":"youtube.captions.insertMedia","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"onBehalfOf","in":"query","required":false,"description":"ID of the Google+ Page for the channel that the request is be on behalf of","schema":{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sync","in":"query","required":false,"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","schema":{"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Caption"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/upload/youtube/v3/channelBanners/insert":{"post":{"operationId":"youtube.channelBanners.insertMedia","x-executor-toolPath":"youtube.channelBanners.insertMedia","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"description":"Unused, channel_id is currently derived from the security context of the requestor.","schema":{"description":"Unused, channel_id is currently derived from the security context of the requestor.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelBannerResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/upload/youtube/v3/playlistImages":{"put":{"operationId":"youtube.playlistImages.updateMedia","x-executor-toolPath":"youtube.playlistImages.updateMedia","tags":["YouTube Data API v3"],"description":"Updates an existing resource. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"The *part* parameter specifies the properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistImage"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.playlistImages.insertMedia","x-executor-toolPath":"youtube.playlistImages.insertMedia","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"The *part* parameter specifies the properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistImage"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/upload/youtube/v3/thumbnails/set":{"post":{"operationId":"youtube.thumbnails.setMedia","x-executor-toolPath":"youtube.thumbnails.setMedia","tags":["YouTube Data API v3"],"description":"As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"videoId","in":"query","required":true,"description":"Returns the Thumbnail with the given video IDs for Stubby or Apiary.","schema":{"description":"Returns the Thumbnail with the given video IDs for Stubby or Apiary.","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ThumbnailSetResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/upload/youtube/v3/videos":{"post":{"operationId":"youtube.videos.insertMedia","x-executor-toolPath":"youtube.videos.insertMedia","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"autoLevels","in":"query","required":false,"description":"Should auto-levels be applied to the upload.","schema":{"description":"Should auto-levels be applied to the upload.","type":"boolean"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"notifySubscribers","in":"query","required":false,"description":"Notify the channel subscribers about the new video. As default, the notification is enabled.","schema":{"description":"Notify the channel subscribers about the new video. As default, the notification is enabled.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"stabilize","in":"query","required":false,"description":"Should stabilize be applied to the upload.","schema":{"description":"Should stabilize be applied to the upload.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Video"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/upload/youtube/v3/watermarks/set":{"post":{"operationId":"youtube.watermarks.setMedia","x-executor-toolPath":"youtube.watermarks.setMedia","tags":["YouTube Data API v3"],"description":"Allows upload of watermark image and setting it for a channel. (media upload)","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":true,"description":"The upload type for the media upload.","schema":{"description":"The upload type for the media upload.","default":"media","enum":["media"],"type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/activities":{"get":{"operationId":"youtube.activities.list","x-executor-toolPath":"youtube.activities.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"home","in":"query","required":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"mine","in":"query","required":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set *part=snippet*, the API response will also contain all of those nested properties.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set *part=snippet*, the API response will also contain all of those nested properties.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"publishedAfter","in":"query","required":false,"schema":{"format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"publishedBefore","in":"query","required":false,"schema":{"format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"regionCode","in":"query","required":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ActivityListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/captions":{"get":{"operationId":"youtube.captions.list","x-executor-toolPath":"youtube.captions.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Returns the captions with the given IDs for Stubby or Apiary.","schema":{"type":"array","items":{"description":"Returns the captions with the given IDs for Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"onBehalfOf","in":"query","required":false,"description":"ID of the Google+ Page for the channel that the request is on behalf of.","schema":{"description":"ID of the Google+ Page for the channel that the request is on behalf of.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"videoId","in":"query","required":true,"description":"Returns the captions for the specified video.","schema":{"description":"Returns the captions for the specified video.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_CaptionListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.captions.update","x-executor-toolPath":"youtube.captions.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"onBehalfOf","in":"query","required":false,"description":"ID of the Google+ Page for the channel that the request is on behalf of.","schema":{"description":"ID of the Google+ Page for the channel that the request is on behalf of.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sync","in":"query","required":false,"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","schema":{"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Caption"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Caption"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.captions.insert","x-executor-toolPath":"youtube.captions.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"onBehalfOf","in":"query","required":false,"description":"ID of the Google+ Page for the channel that the request is be on behalf of","schema":{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"sync","in":"query","required":false,"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","schema":{"description":"Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Caption"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Caption"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.captions.delete","x-executor-toolPath":"youtube.captions.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"onBehalfOf","in":"query","required":false,"description":"ID of the Google+ Page for the channel that the request is be on behalf of","schema":{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/captions/{id}":{"get":{"operationId":"youtube.captions.download","x-executor-toolPath":"youtube.captions.download","tags":["YouTube Data API v3"],"description":"Downloads a caption track.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the caption track to download, required for One Platform.","schema":{"description":"The ID of the caption track to download, required for One Platform.","type":"string"}},{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"onBehalfOf","in":"query","required":false,"description":"ID of the Google+ Page for the channel that the request is be on behalf of","schema":{"description":"ID of the Google+ Page for the channel that the request is be on behalf of","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"tfmt","in":"query","required":false,"description":"Convert the captions into this format. Supported options are sbv, srt, and vtt.","schema":{"description":"Convert the captions into this format. Supported options are sbv, srt, and vtt.","type":"string"},"style":"form","explode":false},{"name":"tlang","in":"query","required":false,"description":"tlang is the language code; machine translate the captions into this language.","schema":{"description":"tlang is the language code; machine translate the captions into this language.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/channelBanners/insert":{"post":{"operationId":"youtube.channelBanners.insert","x-executor-toolPath":"youtube.channelBanners.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"description":"Unused, channel_id is currently derived from the security context of the requestor.","schema":{"description":"Unused, channel_id is currently derived from the security context of the requestor.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelBannerResource"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelBannerResource"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/channelSections":{"get":{"operationId":"youtube.channelSections.list","x-executor-toolPath":"youtube.channelSections.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"description":"Return the ChannelSections owned by the specified channel ID.","schema":{"description":"Return the ChannelSections owned by the specified channel ID.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"description":"Return content in specified language","schema":{"description":"Return content in specified language","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Return the ChannelSections with the given IDs for Stubby or Apiary.","schema":{"type":"array","items":{"description":"Return the ChannelSections with the given IDs for Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"mine","in":"query","required":false,"description":"Return the ChannelSections owned by the authenticated user.","schema":{"description":"Return the ChannelSections owned by the authenticated user.","type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set *part=snippet*, the API response will also contain all of those nested properties.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set *part=snippet*, the API response will also contain all of those nested properties.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelSectionListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.channelSections.update","x-executor-toolPath":"youtube.channelSections.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelSection"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelSection"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.channelSections.insert","x-executor-toolPath":"youtube.channelSections.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelSection"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelSection"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.channelSections.delete","x-executor-toolPath":"youtube.channelSections.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/channels":{"get":{"operationId":"youtube.channels.list","x-executor-toolPath":"youtube.channels.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"categoryId","in":"query","required":false,"description":"Return the channels within the specified guide category ID.","schema":{"description":"Return the channels within the specified guide category ID.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"forHandle","in":"query","required":false,"description":"Return the channel associated with a YouTube handle.","schema":{"description":"Return the channel associated with a YouTube handle.","type":"string"},"style":"form","explode":false},{"name":"forUsername","in":"query","required":false,"description":"Return the channel associated with a YouTube username.","schema":{"description":"Return the channel associated with a YouTube username.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"description":"Stands for \"host language\". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).","schema":{"description":"Stands for \"host language\". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Return the channels with the specified IDs.","schema":{"type":"array","items":{"description":"Return the channels with the specified IDs.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"mine","in":"query","required":false,"description":"Return the ids of channels owned by the authenticated user.","schema":{"description":"Return the ids of channels owned by the authenticated user.","type":"boolean"},"style":"form","explode":false},{"name":"mySubscribers","in":"query","required":false,"description":"Return the channels subscribed to the authenticated user","schema":{"description":"Return the channels subscribed to the authenticated user","type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set *part=contentDetails*, the API response will also contain all of those nested properties.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set *part=contentDetails*, the API response will also contain all of those nested properties.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ChannelListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.channels.update","x-executor-toolPath":"youtube.channels.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Channel"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Channel"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/commentThreads":{"get":{"operationId":"youtube.commentThreads.list","x-executor-toolPath":"youtube.commentThreads.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"allThreadsRelatedToChannelId","in":"query","required":false,"description":"Returns the comment threads of all videos of the channel and the channel comments as well.","schema":{"description":"Returns the comment threads of all videos of the channel and the channel comments as well.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"description":"Returns the comment threads for all the channel comments (ie does not include comments left on videos).","schema":{"description":"Returns the comment threads for all the channel comments (ie does not include comments left on videos).","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Returns the comment threads with the given IDs for Stubby or Apiary.","schema":{"type":"array","items":{"description":"Returns the comment threads with the given IDs for Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"moderationStatus","in":"query","required":false,"description":"Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.","schema":{"description":"Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.","default":"published","enum":["published","heldForReview","likelySpam","rejected"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"order","in":"query","required":false,"schema":{"default":"time","enum":["orderUnspecified","time","relevance"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"searchTerms","in":"query","required":false,"description":"Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.","schema":{"description":"Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.","type":"string"},"style":"form","explode":false},{"name":"textFormat","in":"query","required":false,"description":"The requested text format for the returned comments.","schema":{"description":"The requested text format for the returned comments.","default":"html","enum":["textFormatUnspecified","html","plainText"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"videoId","in":"query","required":false,"description":"Returns the comment threads of the specified video.","schema":{"description":"Returns the comment threads of the specified video.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_CommentThreadListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.commentThreads.insert","x-executor-toolPath":"youtube.commentThreads.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.","schema":{"type":"array","items":{"description":"The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_CommentThread"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_CommentThread"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/comments":{"get":{"operationId":"youtube.comments.list","x-executor-toolPath":"youtube.comments.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Returns the comments with the given IDs for One Platform.","schema":{"type":"array","items":{"description":"Returns the comments with the given IDs for One Platform.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":20,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"parentId","in":"query","required":false,"description":"Returns replies to the specified comment. Note, currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.","schema":{"description":"Returns replies to the specified comment. Note, currently YouTube features only one level of replies (ie replies to top level comments). However replies to replies may be supported in the future.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"textFormat","in":"query","required":false,"description":"The requested text format for the returned comments.","schema":{"description":"The requested text format for the returned comments.","default":"html","enum":["textFormatUnspecified","html","plainText"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_CommentListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.comments.update","x-executor-toolPath":"youtube.comments.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.","schema":{"type":"array","items":{"description":"The *part* parameter identifies the properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Comment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.comments.insert","x-executor-toolPath":"youtube.comments.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.","schema":{"type":"array","items":{"description":"The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Comment"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Comment"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.comments.delete","x-executor-toolPath":"youtube.comments.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/comments/markAsSpam":{"post":{"operationId":"youtube.comments.markAsSpam","x-executor-toolPath":"youtube.comments.markAsSpam","tags":["YouTube Data API v3"],"description":"Expresses the caller's opinion that one or more comments should be flagged as spam.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"description":"Flags the comments with the given IDs as spam in the caller's opinion.","schema":{"type":"array","items":{"description":"Flags the comments with the given IDs as spam in the caller's opinion.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/comments/setModerationStatus":{"post":{"operationId":"youtube.comments.setModerationStatus","x-executor-toolPath":"youtube.comments.setModerationStatus","tags":["YouTube Data API v3"],"description":"Sets the moderation status of one or more comments.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"banAuthor","in":"query","required":false,"description":"If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.","schema":{"description":"If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.","default":false,"type":"boolean"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"description":"Modifies the moderation status of the comments with the given IDs","schema":{"type":"array","items":{"description":"Modifies the moderation status of the comments with the given IDs","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"moderationStatus","in":"query","required":true,"description":"Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: 'heldForReview', 'published' or 'rejected'.","schema":{"description":"Specifies the requested moderation status. Note, comments can be in statuses, which are not available through this call. For example, this call does not allow to mark a comment as 'likely spam'. Valid values: 'heldForReview', 'published' or 'rejected'.","enum":["published","heldForReview","likelySpam","rejected"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/i18nLanguages":{"get":{"operationId":"youtube.i18nLanguages.list","x-executor-toolPath":"youtube.i18nLanguages.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"schema":{"default":"en_US","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the i18nLanguage resource properties that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the i18nLanguage resource properties that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_I18nLanguageListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/i18nRegions":{"get":{"operationId":"youtube.i18nRegions.list","x-executor-toolPath":"youtube.i18nRegions.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"schema":{"default":"en_US","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the i18nRegion resource properties that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the i18nRegion resource properties that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_I18nRegionListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveBroadcasts":{"get":{"operationId":"youtube.liveBroadcasts.list","x-executor-toolPath":"youtube.liveBroadcasts.list","tags":["YouTube Data API v3"],"description":"Retrieve the list of broadcasts associated with the given channel.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"broadcastStatus","in":"query","required":false,"description":"Return broadcasts with a certain status, e.g. active broadcasts.","schema":{"description":"Return broadcasts with a certain status, e.g. active broadcasts.","enum":["broadcastStatusFilterUnspecified","all","active","upcoming","completed"],"type":"string"},"style":"form","explode":false},{"name":"broadcastType","in":"query","required":false,"description":"Return only broadcasts with the selected type.","schema":{"description":"Return only broadcasts with the selected type.","default":"event","enum":["broadcastTypeFilterUnspecified","all","event","persistent"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Return broadcasts with the given ids from Stubby or Apiary.","schema":{"type":"array","items":{"description":"Return broadcasts with the given ids from Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"mine","in":"query","required":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcastListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.liveBroadcasts.update","x-executor-toolPath":"youtube.liveBroadcasts.update","tags":["YouTube Data API v3"],"description":"Updates an existing broadcast for the authenticated user.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcast"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcast"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.liveBroadcasts.insert","x-executor-toolPath":"youtube.liveBroadcasts.insert","tags":["YouTube Data API v3"],"description":"Inserts a new stream for the authenticated user.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcast"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcast"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.liveBroadcasts.delete","x-executor-toolPath":"youtube.liveBroadcasts.delete","tags":["YouTube Data API v3"],"description":"Delete a given broadcast.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"description":"Broadcast to delete.","schema":{"description":"Broadcast to delete.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveBroadcasts/bind":{"post":{"operationId":"youtube.liveBroadcasts.bind","x-executor-toolPath":"youtube.liveBroadcasts.bind","tags":["YouTube Data API v3"],"description":"Bind a broadcast to a stream.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"description":"Broadcast to bind to the stream","schema":{"description":"Broadcast to bind to the stream","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"streamId","in":"query","required":false,"description":"Stream to bind, if not set unbind the current one.","schema":{"description":"Stream to bind, if not set unbind the current one.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcast"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveBroadcasts/cuepoint":{"post":{"operationId":"youtube.liveBroadcasts.insertCuepoint","x-executor-toolPath":"youtube.liveBroadcasts.insertCuepoint","tags":["YouTube Data API v3"],"description":"Insert cuepoints in a broadcast","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Broadcast to insert ads to, or equivalently `external_video_id` for internal use.","schema":{"description":"Broadcast to insert ads to, or equivalently `external_video_id` for internal use.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Cuepoint"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Cuepoint"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveBroadcasts/transition":{"post":{"operationId":"youtube.liveBroadcasts.transition","x-executor-toolPath":"youtube.liveBroadcasts.transition","tags":["YouTube Data API v3"],"description":"Transition a broadcast to a given status.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"broadcastStatus","in":"query","required":true,"description":"The status to which the broadcast is going to transition.","schema":{"description":"The status to which the broadcast is going to transition.","enum":["statusUnspecified","testing","live","complete"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"description":"Broadcast to transition.","schema":{"description":"Broadcast to transition.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcast"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveChat/bans":{"post":{"operationId":"youtube.liveChatBans.insert","x-executor-toolPath":"youtube.liveChatBans.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatBan"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatBan"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.liveChatBans.delete","x-executor-toolPath":"youtube.liveChatBans.delete","tags":["YouTube Data API v3"],"description":"Deletes a chat ban.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveChat/messages":{"get":{"operationId":"youtube.liveChatMessages.list","x-executor-toolPath":"youtube.liveChatMessages.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"description":"Specifies the localization language in which the system messages should be returned.","schema":{"description":"Specifies the localization language in which the system messages should be returned.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"liveChatId","in":"query","required":true,"description":"The id of the live chat for which comments should be returned.","schema":{"description":"The id of the live chat for which comments should be returned.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.","format":"uint32","default":500,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"profileImageSize","in":"query","required":false,"description":"Specifies the size of the profile image that should be returned for each user.","schema":{"description":"Specifies the size of the profile image that should be returned for each user.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessageListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.liveChatMessages.insert","x-executor-toolPath":"youtube.liveChatMessages.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessage"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessage"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.liveChatMessages.delete","x-executor-toolPath":"youtube.liveChatMessages.delete","tags":["YouTube Data API v3"],"description":"Deletes a chat message.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveChat/messages/stream":{"get":{"operationId":"youtube.youtube.v3.liveChat.messages.stream","x-executor-toolPath":"youtube.youtube.v3.liveChat.messages.stream","tags":["YouTube Data API v3"],"description":"Allows a user to load live chat through a server-streamed RPC.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"description":"Specifies the localization language in which the system messages should be returned.","schema":{"description":"Specifies the localization language in which the system messages should be returned.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"liveChatId","in":"query","required":false,"description":"The id of the live chat for which comments should be returned.","schema":{"description":"The id of the live chat for which comments should be returned.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.","format":"uint32","default":500,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"profileImageSize","in":"query","required":false,"description":"Specifies the size of the profile image that should be returned for each user.","schema":{"description":"Specifies the size of the profile image that should be returned for each user.","format":"uint32","type":"integer"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessageListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveChat/messages/transition":{"post":{"operationId":"youtube.liveChatMessages.transition","x-executor-toolPath":"youtube.liveChatMessages.transition","tags":["YouTube Data API v3"],"description":"Transition a durable chat event.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"The ID that uniquely identify the chat message event to transition.","schema":{"description":"The ID that uniquely identify the chat message event to transition.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"status","in":"query","required":false,"description":"The status to which the chat event is going to transition.","schema":{"description":"The status to which the chat event is going to transition.","enum":["statusUnspecified","closed"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessage"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveChat/moderators":{"get":{"operationId":"youtube.liveChatModerators.list","x-executor-toolPath":"youtube.liveChatModerators.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"liveChatId","in":"query","required":true,"description":"The id of the live chat for which moderators should be returned.","schema":{"description":"The id of the live chat for which moderators should be returned.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatModeratorListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.liveChatModerators.insert","x-executor-toolPath":"youtube.liveChatModerators.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatModerator"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveChatModerator"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.liveChatModerators.delete","x-executor-toolPath":"youtube.liveChatModerators.delete","tags":["YouTube Data API v3"],"description":"Deletes a chat moderator.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/liveStreams":{"get":{"operationId":"youtube.liveStreams.list","x-executor-toolPath":"youtube.liveStreams.list","tags":["YouTube Data API v3"],"description":"Retrieve the list of streams associated with the given channel. --","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Return LiveStreams with the given ids from Stubby or Apiary.","schema":{"type":"array","items":{"description":"Return LiveStreams with the given ids from Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"mine","in":"query","required":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveStreamListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.liveStreams.update","x-executor-toolPath":"youtube.liveStreams.update","tags":["YouTube Data API v3"],"description":"Updates an existing stream for the authenticated user.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveStream"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveStream"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.liveStreams.insert","x-executor-toolPath":"youtube.liveStreams.insert","tags":["YouTube Data API v3"],"description":"Inserts a new stream for the authenticated user.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, content_details, and status.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, content_details, and status.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveStream"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_LiveStream"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.liveStreams.delete","x-executor-toolPath":"youtube.liveStreams.delete","tags":["YouTube Data API v3"],"description":"Deletes an existing stream for the authenticated user.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/members":{"get":{"operationId":"youtube.members.list","x-executor-toolPath":"youtube.members.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of members that match the request criteria for a channel.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"filterByMemberChannelId","in":"query","required":false,"description":"Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response.","schema":{"description":"Comma separated list of channel IDs. Only data about members that are part of this list will be included in the response.","type":"string"},"style":"form","explode":false},{"name":"hasAccessToLevel","in":"query","required":false,"description":"Filter members in the results set to the ones that have access to a level.","schema":{"description":"Filter members in the results set to the ones that have access to a level.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"mode","in":"query","required":false,"description":"Parameter that specifies which channel members to return.","schema":{"description":"Parameter that specifies which channel members to return.","default":"all_current","enum":["listMembersModeUnknown","updates","all_current"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_MemberListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.channel-memberships.creator"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.channel-memberships.creator"]}},"/youtube/v3/membershipsLevels":{"get":{"operationId":"youtube.membershipsLevels.list","x-executor-toolPath":"youtube.membershipsLevels.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of all pricing levels offered by a creator to the fans.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the membershipsLevel resource parts that the API response will include. Supported values are id and snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the membershipsLevel resource parts that the API response will include. Supported values are id and snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_MembershipsLevelListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.channel-memberships.creator"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.channel-memberships.creator"]}},"/youtube/v3/playlistImages":{"get":{"operationId":"youtube.playlistImages.list","x-executor-toolPath":"youtube.playlistImages.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"parent","in":"query","required":false,"description":"Return PlaylistImages for this playlist id.","schema":{"description":"Return PlaylistImages for this playlist id.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"The *part* parameter specifies a comma-separated list of one or more playlistImage resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more playlistImage resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistImageListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.playlistImages.update","x-executor-toolPath":"youtube.playlistImages.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"The *part* parameter specifies the properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistImage"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistImage"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.playlistImages.insert","x-executor-toolPath":"youtube.playlistImages.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"The *part* parameter specifies the properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistImage"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistImage"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.playlistImages.delete","x-executor-toolPath":"youtube.playlistImages.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Id to identify this image. This is returned from by the List method.","schema":{"description":"Id to identify this image. This is returned from by the List method.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/playlistItems":{"get":{"operationId":"youtube.playlistItems.list","x-executor-toolPath":"youtube.playlistItems.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set *part=snippet*, the API response will contain all of those properties.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set *part=snippet*, the API response will contain all of those properties.","type":"string"}},"style":"form","explode":true},{"name":"playlistId","in":"query","required":false,"description":"Return the playlist items within the given playlist.","schema":{"description":"Return the playlist items within the given playlist.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"videoId","in":"query","required":false,"description":"Return the playlist items associated with the given video ID.","schema":{"description":"Return the playlist items associated with the given video ID.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistItemListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.playlistItems.update","x-executor-toolPath":"youtube.playlistItems.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistItem"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistItem"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.playlistItems.insert","x-executor-toolPath":"youtube.playlistItems.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistItem"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistItem"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.playlistItems.delete","x-executor-toolPath":"youtube.playlistItems.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/playlists":{"get":{"operationId":"youtube.playlists.list","x-executor-toolPath":"youtube.playlists.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"description":"Return the playlists owned by the specified channel ID.","schema":{"description":"Return the playlists owned by the specified channel ID.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"description":"Return content in specified language","schema":{"description":"Return content in specified language","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Return the playlists with the given IDs for Stubby or Apiary.","schema":{"type":"array","items":{"description":"Return the playlists with the given IDs for Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"mine","in":"query","required":false,"description":"Return the playlists owned by the authenticated user.","schema":{"description":"Return the playlists owned by the authenticated user.","type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set *part=snippet*, the API response will contain all of those properties.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set *part=snippet*, the API response will contain all of those properties.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_PlaylistListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.playlists.update","x-executor-toolPath":"youtube.playlists.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for mutable properties that are contained in any parts that the request body specifies. For example, a playlist's description is contained in the snippet part, which must be included in the request body. If the request does not specify a value for the snippet.description property, the playlist's existing description will be deleted.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for mutable properties that are contained in any parts that the request body specifies. For example, a playlist's description is contained in the snippet part, which must be included in the request body. If the request does not specify a value for the snippet.description property, the playlist's existing description will be deleted.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Playlist"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Playlist"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.playlists.insert","x-executor-toolPath":"youtube.playlists.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Playlist"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Playlist"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.playlists.delete","x-executor-toolPath":"youtube.playlists.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/search":{"get":{"operationId":"youtube.search.list","x-executor-toolPath":"youtube.search.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of search resources","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"description":"Filter on resources belonging to this channelId. (Force TAP rebuild)","schema":{"description":"Filter on resources belonging to this channelId. (Force TAP rebuild)","type":"string"},"style":"form","explode":false},{"name":"channelType","in":"query","required":false,"description":"Add a filter on the channel search.","schema":{"description":"Add a filter on the channel search.","enum":["channelTypeUnspecified","any","show"],"type":"string"},"style":"form","explode":false},{"name":"eventType","in":"query","required":false,"description":"Filter on the livestream status of the videos.","schema":{"description":"Filter on the livestream status of the videos.","enum":["none","upcoming","live","completed"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"forDeveloper","in":"query","required":false,"description":"Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.","schema":{"description":"Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.","type":"boolean"},"style":"form","explode":false},{"name":"forMine","in":"query","required":false,"description":"Search for the private videos of the authenticated user.","schema":{"description":"Search for the private videos of the authenticated user.","type":"boolean"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"location","in":"query","required":false,"description":"Filter on location of the video","schema":{"description":"Filter on location of the video","type":"string"},"style":"form","explode":false},{"name":"locationRadius","in":"query","required":false,"description":"Filter on distance from the location (specified above).","schema":{"description":"Filter on distance from the location (specified above).","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"order","in":"query","required":false,"description":"Sort order of the results.","schema":{"description":"Sort order of the results.","default":"relevance","enum":["searchSortUnspecified","date","rating","viewCount","relevance","title","videoCount"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"publishedAfter","in":"query","required":false,"description":"Filter on resources published after this date.","schema":{"description":"Filter on resources published after this date.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"publishedBefore","in":"query","required":false,"description":"Filter on resources published before this date.","schema":{"description":"Filter on resources published before this date.","format":"google-datetime","type":"string"},"style":"form","explode":false},{"name":"q","in":"query","required":false,"description":"Textual search terms to match.","schema":{"description":"Textual search terms to match.","type":"string"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"regionCode","in":"query","required":false,"description":"Display the content as seen by viewers in this country.","schema":{"description":"Display the content as seen by viewers in this country.","type":"string"},"style":"form","explode":false},{"name":"relevanceLanguage","in":"query","required":false,"description":"Return results relevant to this language.","schema":{"description":"Return results relevant to this language.","type":"string"},"style":"form","explode":false},{"name":"safeSearch","in":"query","required":false,"description":"Indicates whether the search results should include restricted content as well as standard content.","schema":{"description":"Indicates whether the search results should include restricted content as well as standard content.","default":"moderate","enum":["safeSearchSettingUnspecified","none","moderate","strict"],"type":"string"},"style":"form","explode":false},{"name":"topicId","in":"query","required":false,"description":"Restrict results to a particular topic.","schema":{"description":"Restrict results to a particular topic.","type":"string"},"style":"form","explode":false},{"name":"type","in":"query","required":false,"description":"Restrict results to a particular set of resource types from One Platform.","schema":{"type":"array","items":{"description":"Restrict results to a particular set of resource types from One Platform.","type":"string"}},"style":"form","explode":true},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"videoCaption","in":"query","required":false,"description":"Filter on the presence of captions on the videos.","schema":{"description":"Filter on the presence of captions on the videos.","enum":["videoCaptionUnspecified","any","closedCaption","none"],"type":"string"},"style":"form","explode":false},{"name":"videoCategoryId","in":"query","required":false,"description":"Filter on videos in a specific category.","schema":{"description":"Filter on videos in a specific category.","type":"string"},"style":"form","explode":false},{"name":"videoDefinition","in":"query","required":false,"description":"Filter on the definition of the videos.","schema":{"description":"Filter on the definition of the videos.","enum":["any","standard","high"],"type":"string"},"style":"form","explode":false},{"name":"videoDimension","in":"query","required":false,"description":"Filter on 3d videos.","schema":{"description":"Filter on 3d videos.","enum":["any","2d","3d"],"type":"string"},"style":"form","explode":false},{"name":"videoDuration","in":"query","required":false,"description":"Filter on the duration of the videos.","schema":{"description":"Filter on the duration of the videos.","enum":["videoDurationUnspecified","any","short","medium","long"],"type":"string"},"style":"form","explode":false},{"name":"videoEmbeddable","in":"query","required":false,"description":"Filter on embeddable videos.","schema":{"description":"Filter on embeddable videos.","enum":["videoEmbeddableUnspecified","any","true"],"type":"string"},"style":"form","explode":false},{"name":"videoLicense","in":"query","required":false,"description":"Filter on the license of the videos.","schema":{"description":"Filter on the license of the videos.","enum":["any","youtube","creativeCommon"],"type":"string"},"style":"form","explode":false},{"name":"videoPaidProductPlacement","in":"query","required":false,"schema":{"enum":["videoPaidProductPlacementUnspecified","any","true"],"type":"string"},"style":"form","explode":false},{"name":"videoSyndicated","in":"query","required":false,"description":"Filter on syndicated videos.","schema":{"description":"Filter on syndicated videos.","enum":["videoSyndicatedUnspecified","any","true"],"type":"string"},"style":"form","explode":false},{"name":"videoType","in":"query","required":false,"description":"Filter on videos of a specific type.","schema":{"description":"Filter on videos of a specific type.","enum":["videoTypeUnspecified","any","movie","episode"],"type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_SearchListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/subscriptions":{"get":{"operationId":"youtube.subscriptions.list","x-executor-toolPath":"youtube.subscriptions.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":false,"description":"Return the subscriptions of the given channel owner.","schema":{"description":"Return the subscriptions of the given channel owner.","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"forChannelId","in":"query","required":false,"description":"Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.","schema":{"description":"Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Return the subscriptions with the given IDs for Stubby or Apiary.","schema":{"type":"array","items":{"description":"Return the subscriptions with the given IDs for Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"mine","in":"query","required":false,"description":"Flag for returning the subscriptions of the authenticated user.","schema":{"description":"Flag for returning the subscriptions of the authenticated user.","type":"boolean"},"style":"form","explode":false},{"name":"myRecentSubscribers","in":"query","required":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"mySubscribers","in":"query","required":false,"description":"Return the subscribers of the given channel owner.","schema":{"description":"Return the subscribers of the given channel owner.","type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"order","in":"query","required":false,"description":"The order of the returned subscriptions","schema":{"description":"The order of the returned subscriptions","default":"relevance","enum":["subscriptionOrderUnspecified","relevance","unread","alphabetical"],"type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set *part=snippet*, the API response will also contain all of those nested properties.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set *part=snippet*, the API response will also contain all of those nested properties.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_SubscriptionListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.subscriptions.insert","x-executor-toolPath":"youtube.subscriptions.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Subscription"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Subscription"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.subscriptions.delete","x-executor-toolPath":"youtube.subscriptions.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/superChatEvents":{"get":{"operationId":"youtube.superChatEvents.list","x-executor-toolPath":"youtube.superChatEvents.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"description":"Return rendered funding amounts in specified language.","schema":{"description":"Return rendered funding amounts in specified language.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_SuperChatEventListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/thumbnails/set":{"post":{"operationId":"youtube.thumbnails.set","x-executor-toolPath":"youtube.thumbnails.set","tags":["YouTube Data API v3"],"description":"As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"videoId","in":"query","required":true,"description":"Returns the Thumbnail with the given video IDs for Stubby or Apiary.","schema":{"description":"Returns the Thumbnail with the given video IDs for Stubby or Apiary.","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_ThumbnailSetResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videoAbuseReportReasons":{"get":{"operationId":"youtube.videoAbuseReportReasons.list","x-executor-toolPath":"youtube.videoAbuseReportReasons.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"schema":{"default":"en-US","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the videoCategory resource parts that the API response will include. Supported values are id and snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_VideoAbuseReportReasonListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videoCategories":{"get":{"operationId":"youtube.videoCategories.list","x-executor-toolPath":"youtube.videoCategories.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"schema":{"default":"en-US","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Returns the video categories with the given IDs for Stubby or Apiary.","schema":{"type":"array","items":{"description":"Returns the video categories with the given IDs for Stubby or Apiary.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet.","schema":{"type":"array","items":{"description":"The *part* parameter specifies the videoCategory resource properties that the API response will include. Set the parameter value to snippet.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"regionCode","in":"query","required":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_VideoCategoryListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videoTrainability":{"get":{"operationId":"youtube.videoTrainability.get","x-executor-toolPath":"youtube.videoTrainability.get","tags":["YouTube Data API v3"],"description":"Returns the trainability status of a video.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"The ID of the video to retrieve.","schema":{"description":"The ID of the video to retrieve.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_VideoTrainability"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videos":{"get":{"operationId":"youtube.videos.list","x-executor-toolPath":"youtube.videos.list","tags":["YouTube Data API v3"],"description":"Retrieves a list of resources, possibly filtered.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"chart","in":"query","required":false,"description":"Return the videos that are in the specified chart.","schema":{"description":"Return the videos that are in the specified chart.","enum":["chartUnspecified","mostPopular"],"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"hl","in":"query","required":false,"description":"Stands for \"host language\". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).","schema":{"description":"Stands for \"host language\". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Return videos with the given ids.","schema":{"type":"array","items":{"description":"Return videos with the given ids.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"locale","in":"query","required":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"maxHeight","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"style":"form","explode":false},{"name":"maxResults","in":"query","required":false,"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. *Note:* This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.","schema":{"description":"The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. *Note:* This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.","format":"uint32","default":5,"type":"integer"},"style":"form","explode":false},{"name":"maxWidth","in":"query","required":false,"description":"Return the player with maximum height specified in","schema":{"description":"Return the player with maximum height specified in","format":"int32","type":"integer"},"style":"form","explode":false},{"name":"myRating","in":"query","required":false,"description":"Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.","schema":{"description":"Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.","enum":["none","like","dislike"],"type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"pageToken","in":"query","required":false,"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. *Note:* This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.","schema":{"description":"The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. *Note:* This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter specifies a comma-separated list of one or more video resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set *part=snippet*, the API response will contain all of those properties.","schema":{"type":"array","items":{"description":"The *part* parameter specifies a comma-separated list of one or more video resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set *part=snippet*, the API response will contain all of those properties.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"regionCode","in":"query","required":false,"description":"Use a chart that is specific to the specified region","schema":{"description":"Use a chart that is specific to the specified region","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"videoCategoryId","in":"query","required":false,"description":"Use chart that is specific to the specified video category","schema":{"description":"Use chart that is specific to the specified video category","default":"0","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_VideoListResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"put":{"operationId":"youtube.videos.update","x-executor-toolPath":"youtube.videos.update","tags":["YouTube Data API v3"],"description":"Updates an existing resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Video"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Video"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"post":{"operationId":"youtube.videos.insert","x-executor-toolPath":"youtube.videos.insert","tags":["YouTube Data API v3"],"description":"Inserts a new resource into this collection.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"autoLevels","in":"query","required":false,"description":"Should auto-levels be applied to the upload.","schema":{"description":"Should auto-levels be applied to the upload.","type":"boolean"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"notifySubscribers","in":"query","required":false,"description":"Notify the channel subscribers about the new video. As default, the notification is enabled.","schema":{"description":"Notify the channel subscribers about the new video. As default, the notification is enabled.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":true,"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.","schema":{"type":"array","items":{"description":"The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"stabilize","in":"query","required":false,"description":"Should stabilize be applied to the upload.","schema":{"description":"Should stabilize be applied to the upload.","type":"boolean"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Video"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_Video"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]},"delete":{"operationId":"youtube.videos.delete","x-executor-toolPath":"youtube.videos.delete","tags":["YouTube Data API v3"],"description":"Deletes a resource.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videos/getRating":{"get":{"operationId":"youtube.videos.getRating","x-executor-toolPath":"youtube.videos.getRating","tags":["YouTube Data API v3"],"description":"Retrieves the ratings that the authorized user gave to a list of specified videos.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_VideoGetRatingResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videos/rate":{"post":{"operationId":"youtube.videos.rate","x-executor-toolPath":"youtube.videos.rate","tags":["YouTube Data API v3"],"description":"Adds a like or dislike rating to a video or removes a rating from a video.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"rating","in":"query","required":true,"schema":{"enum":["none","like","dislike"],"type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videos/reportAbuse":{"post":{"operationId":"youtube.videos.reportAbuse","x-executor-toolPath":"youtube.videos.reportAbuse","tags":["YouTube Data API v3"],"description":"Report abuse for a video.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_VideoAbuseReport"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/videos:batchGetStats":{"get":{"operationId":"youtube.videos.batchGetStats","x-executor-toolPath":"youtube.videos.batchGetStats","tags":["YouTube Data API v3"],"description":"Retrieves a batch of VideoStat resources, possibly filtered. BatchGetStats is intentionally not atomic to provide a better user experience.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"id","in":"query","required":false,"description":"Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.","schema":{"type":"array","items":{"description":"Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.","type":"string"}},"style":"form","explode":true},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"part","in":"query","required":false,"description":"Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties.","schema":{"type":"array","items":{"description":"Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties.","type":"string"}},"style":"form","explode":true},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_BatchGetStatsResponse"}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/watermarks/set":{"post":{"operationId":"youtube.watermarks.set","x-executor-toolPath":"youtube.watermarks.set","tags":["YouTube Data API v3"],"description":"Allows upload of watermark image and setting it for a channel.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/youtube_v3_InvideoBranding"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}},"/youtube/v3/watermarks/unset":{"post":{"operationId":"youtube.watermarks.unset","x-executor-toolPath":"youtube.watermarks.unset","tags":["YouTube Data API v3"],"description":"Allows removal of channel watermark.","parameters":[{"name":"$.xgafv","in":"query","required":false,"description":"V1 error format.","schema":{"description":"V1 error format.","enum":["1","2"],"type":"string"},"style":"form","explode":false},{"name":"access_token","in":"query","required":false,"description":"OAuth access token.","schema":{"description":"OAuth access token.","type":"string"},"style":"form","explode":false},{"name":"alt","in":"query","required":false,"description":"Data format for response.","schema":{"description":"Data format for response.","default":"json","enum":["json","media","proto"],"type":"string"},"style":"form","explode":false},{"name":"callback","in":"query","required":false,"description":"JSONP","schema":{"description":"JSONP","type":"string"},"style":"form","explode":false},{"name":"channelId","in":"query","required":true,"schema":{"type":"string"},"style":"form","explode":false},{"name":"fields","in":"query","required":false,"description":"Selector specifying which fields to include in a partial response.","schema":{"description":"Selector specifying which fields to include in a partial response.","type":"string"},"style":"form","explode":false},{"name":"key","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"oauth_token","in":"query","required":false,"description":"OAuth 2.0 token for the current user.","schema":{"description":"OAuth 2.0 token for the current user.","type":"string"},"style":"form","explode":false},{"name":"prettyPrint","in":"query","required":false,"description":"Returns response with indentations and line breaks.","schema":{"description":"Returns response with indentations and line breaks.","default":true,"type":"boolean"},"style":"form","explode":false},{"name":"quotaUser","in":"query","required":false,"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.","schema":{"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.","type":"string"},"style":"form","explode":false},{"name":"uploadType","in":"query","required":false,"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","schema":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string"},"style":"form","explode":false},{"name":"upload_protocol","in":"query","required":false,"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","schema":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string"},"style":"form","explode":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}}},"security":[{"googleOAuth2":["https://www.googleapis.com/auth/youtube.force-ssl"]}],"x-google-scopes":["https://www.googleapis.com/auth/youtube.force-ssl"]}}},"components":{"schemas":{"youtube_v3_AbuseReport":{"type":"object","properties":{"abuseTypes":{"type":"array","items":{"$ref":"#/components/schemas/youtube_v3_AbuseType"}},"description":{"type":"string"},"relatedEntities":{"type":"array","items":{"$ref":"#/components/schemas/youtube_v3_RelatedEntity"}},"subject":{"$ref":"#/components/schemas/youtube_v3_Entity"}}},"youtube_v3_AbuseType":{"type":"object","properties":{"id":{"type":"string"}}},"youtube_v3_AccessPolicy":{"description":"Rights management policy for YouTube resources.","type":"object","properties":{"allowed":{"description":"The value of allowed indicates whether the access to the policy is allowed or denied by default.","type":"boolean"},"exception":{"description":"A list of region codes that identify countries where the default policy do not apply.","type":"array","items":{"type":"string"}}}},"youtube_v3_Activity":{"description":"An `activity` resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include sharing a video, uploading a video, and so forth. Each `activity` resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.","type":"object","properties":{"contentDetails":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetails"},"etag":{"description":"Etag of this resource","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the activity.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: The fixed string `\"youtube#activity\"`.","default":"youtube#activity","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_ActivitySnippet"}}},"youtube_v3_ActivityContentDetails":{"description":"Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc.","type":"object","properties":{"bulletin":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsBulletin"},"channelItem":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsChannelItem"},"comment":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsComment"},"playlistItem":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsPlaylistItem"},"promotedItem":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsPromotedItem"},"recommendation":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsRecommendation"},"social":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsSocial"},"subscription":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsSubscription"},"upload":{"$ref":"#/components/schemas/youtube_v3_ActivityContentDetailsUpload"}}},"youtube_v3_ActivityContentDetailsBulletin":{"description":"Details about a channel bulletin post.","type":"object","properties":{"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"}}},"youtube_v3_ActivityContentDetailsChannelItem":{"description":"Details about a resource which was added to a channel.","type":"object","properties":{"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"}}},"youtube_v3_ActivityContentDetailsComment":{"description":"Information about a resource that received a comment.","type":"object","properties":{"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"}}},"youtube_v3_ActivityContentDetailsPlaylistItem":{"description":"Information about a new playlist item.","type":"object","properties":{"playlistId":{"description":"The value that YouTube uses to uniquely identify the playlist.","type":"string"},"playlistItemId":{"description":"ID of the item within the playlist.","type":"string"},"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"}}},"youtube_v3_ActivityContentDetailsPromotedItem":{"description":"Details about a resource which is being promoted.","type":"object","properties":{"adTag":{"description":"The URL the client should fetch to request a promoted item.","type":"string"},"clickTrackingUrl":{"description":"The URL the client should ping to indicate that the user clicked through on this promoted item.","type":"string"},"creativeViewUrl":{"description":"The URL the client should ping to indicate that the user was shown this promoted item.","type":"string"},"ctaType":{"description":"The type of call-to-action, a message to the user indicating action that can be taken.","enum":["ctaTypeUnspecified","visitAdvertiserSite"],"type":"string"},"customCtaButtonText":{"description":"The custom call-to-action button text. If specified, it will override the default button text for the cta_type.","type":"string"},"descriptionText":{"description":"The text description to accompany the promoted item.","type":"string"},"destinationUrl":{"description":"The URL the client should direct the user to, if the user chooses to visit the advertiser's website.","type":"string"},"forecastingUrl":{"description":"The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.","type":"array","items":{"type":"string"}},"impressionUrl":{"description":"The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.","type":"array","items":{"type":"string"}},"videoId":{"description":"The ID that YouTube uses to uniquely identify the promoted video.","type":"string"}}},"youtube_v3_ActivityContentDetailsRecommendation":{"description":"Information that identifies the recommended resource.","type":"object","properties":{"reason":{"description":"The reason that the resource is recommended to the user.","enum":["reasonUnspecified","videoWatched"],"type":"string"},"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"},"seedResourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"}}},"youtube_v3_ActivityContentDetailsSocial":{"description":"Details about a social network post.","type":"object","properties":{"author":{"description":"The author of the social network post.","type":"string"},"imageUrl":{"description":"An image of the post's author.","type":"string"},"referenceUrl":{"description":"The URL of the social network post.","type":"string"},"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"},"type":{"description":"The name of the social network.","enum":["unspecified","googlePlus","facebook","twitter"],"type":"string"}}},"youtube_v3_ActivityContentDetailsSubscription":{"description":"Information about a channel that a user subscribed to.","type":"object","properties":{"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"}}},"youtube_v3_ActivityContentDetailsUpload":{"description":"Information about the uploaded video.","type":"object","properties":{"videoId":{"description":"The ID that YouTube uses to uniquely identify the uploaded video.","type":"string"}}},"youtube_v3_ActivityListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/youtube_v3_Activity"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#activityListResponse\".","default":"youtube#activityListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_ActivitySnippet":{"description":"Basic details about an activity, including title, description, thumbnails, activity type and group. Next ID: 12","type":"object","properties":{"channelId":{"description":"The ID that YouTube uses to uniquely identify the channel associated with the activity.","type":"string"},"channelTitle":{"description":"Channel title for the channel responsible for this activity","type":"string"},"description":{"description":"The description of the resource primarily associated with the activity. @mutable youtube.activities.insert","type":"string"},"groupId":{"description":"The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user uploads a video and watches the same video, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same `groupId` value.","type":"string"},"publishedAt":{"description":"The date and time that the video was uploaded.","format":"date-time","type":"string"},"thumbnails":{"$ref":"#/components/schemas/youtube_v3_ThumbnailDetails"},"title":{"description":"The title of the resource primarily associated with the activity.","type":"string"},"type":{"description":"The type of activity that the resource describes.","enum":["typeUnspecified","upload","comment","subscription","playlistItem","recommendation","bulletin","social","channelItem","promotedItem"],"type":"string"}}},"youtube_v3_AvailabilityConfig":{"description":"Common proto for Live and VOD geo-restrictions","type":"object","properties":{"globalConfig":{"$ref":"#/components/schemas/youtube_v3_AvailabilityConfigGlobalConfig"},"regionsConfig":{"$ref":"#/components/schemas/youtube_v3_AvailabilityConfigRegionsConfig"}}},"youtube_v3_AvailabilityConfigGlobalConfig":{"description":"Video is available in all regions except the ones specified in the excluded_region_codes list.","type":"object","properties":{"excludedRegionCodes":{"description":"Optional. Regions where video is blocked","type":"array","items":{"type":"string"}},"interval":{"$ref":"#/components/schemas/youtube_v3_Interval"}}},"youtube_v3_AvailabilityConfigRegionsConfig":{"description":"Video is available in the specified regions only.","type":"object","properties":{"regionIntervals":{"description":"Required. List of regions and time windows where video is available. If a region is specified multiple times, the union of all intervals is used.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_AvailabilityConfigRegionsConfigRegionInterval"}}}},"youtube_v3_AvailabilityConfigRegionsConfigRegionInterval":{"description":"Region and time window where video is available for the region.","type":"object","properties":{"interval":{"$ref":"#/components/schemas/youtube_v3_Interval"},"regionCode":{"description":"Required. Region where video is available","type":"string"}}},"youtube_v3_BatchGetStatsResponse":{"description":"Response for the Videos.stats API. Returns VideoStat information about a batch of videos. VideoStat contains a subset of the information in Video that is relevant to statistics and content details. BatchGetStats is intentionally not atomic to provide a better user experience. BatchGetStatsResponse returns a summary to help users understand the outcome of the operation.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"items":{"description":"The videos' stats information.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_VideoStat"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#batchGetStatsResponse\".","default":"youtube#batchGetStatsResponse","type":"string"}}},"youtube_v3_BrandPartner":{"description":"Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6","type":"object","properties":{"channelHandle":{"description":"Required. Channel handle, must begin with \"@\"","type":"string"},"channelId":{"description":"Required. External Channel ID, must begin with \"UC\"","type":"string"}}},"youtube_v3_Caption":{"description":"A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the caption track.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#caption\".","default":"youtube#caption","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_CaptionSnippet"}}},"youtube_v3_CaptionListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of captions that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_Caption"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#captionListResponse\".","default":"youtube#captionListResponse","type":"string"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_CaptionSnippet":{"description":"Basic details about a caption track, such as its language and name.","type":"object","properties":{"audioTrackType":{"description":"The type of audio track associated with the caption track.","enum":["unknown","primary","commentary","descriptive"],"type":"string"},"failureReason":{"description":"The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.","enum":["unknownFormat","unsupportedFormat","processingFailed"],"type":"string"},"isAutoSynced":{"description":"Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.","type":"boolean"},"isCC":{"description":"Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.","type":"boolean"},"isDraft":{"description":"Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update","type":"boolean"},"isEasyReader":{"description":"Indicates whether caption track is formatted for \"easy reader,\" meaning it is at a third-grade level for language learners. The default value is false.","type":"boolean"},"isLarge":{"description":"Indicates whether the caption track uses large text for the vision-impaired. The default value is false.","type":"boolean"},"language":{"description":"The language of the caption track. The property value is a BCP-47 language tag.","type":"string"},"lastUpdated":{"description":"The date and time when the caption track was last updated.","format":"date-time","type":"string"},"name":{"description":"The name of the caption track. The name is intended to be visible to the user as an option during playback.","type":"string"},"status":{"description":"The caption track's status.","enum":["serving","syncing","failed"],"type":"string"},"trackKind":{"description":"The caption track's type.","enum":["standard","ASR","forced"],"type":"string"},"videoId":{"description":"The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert","type":"string"}}},"youtube_v3_CdnSettings":{"description":"Brief description of the live stream cdn settings.","type":"object","properties":{"format":{"description":"The format of the video stream that you are sending to Youtube. ","type":"string"},"frameRate":{"description":"The frame rate of the inbound video data.","enum":["30fps","60fps","variable"],"type":"string"},"ingestionInfo":{"$ref":"#/components/schemas/youtube_v3_IngestionInfo"},"ingestionType":{"description":" The method or protocol used to transmit the video stream.","enum":["rtmp","dash","webrtc","hls"],"type":"string"},"resolution":{"description":"The resolution of the inbound video data.","enum":["240p","360p","480p","720p","1080p","1440p","2160p","variable"],"type":"string"}}},"youtube_v3_Channel":{"description":"A *channel* resource contains information about a YouTube channel.","type":"object","properties":{"auditDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelAuditDetails"},"brandingSettings":{"$ref":"#/components/schemas/youtube_v3_ChannelBrandingSettings"},"contentDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelContentDetails"},"contentOwnerDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelContentOwnerDetails"},"conversionPings":{"$ref":"#/components/schemas/youtube_v3_ChannelConversionPings"},"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the channel.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channel\".","default":"youtube#channel","type":"string"},"localizations":{"description":"Localizations for different languages","type":"object","additionalProperties":{"$ref":"#/components/schemas/youtube_v3_ChannelLocalization"}},"snippet":{"$ref":"#/components/schemas/youtube_v3_ChannelSnippet"},"statistics":{"$ref":"#/components/schemas/youtube_v3_ChannelStatistics"},"status":{"$ref":"#/components/schemas/youtube_v3_ChannelStatus"},"topicDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelTopicDetails"}}},"youtube_v3_ChannelAuditDetails":{"description":"The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process.","type":"object","properties":{"communityGuidelinesGoodStanding":{"description":"Whether or not the channel respects the community guidelines.","type":"boolean"},"contentIdClaimsGoodStanding":{"description":"Whether or not the channel has any unresolved claims.","type":"boolean"},"copyrightStrikesGoodStanding":{"description":"Whether or not the channel has any copyright strikes.","type":"boolean"}}},"youtube_v3_ChannelBannerResource":{"description":"A channel banner returned as the response to a channel_banner.insert call.","type":"object","properties":{"etag":{"type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channelBannerResource\".","default":"youtube#channelBannerResource","type":"string"},"url":{"description":"The URL of this banner image.","type":"string"}}},"youtube_v3_ChannelBrandingSettings":{"description":"Branding properties of a YouTube channel.","type":"object","properties":{"channel":{"$ref":"#/components/schemas/youtube_v3_ChannelSettings"},"hints":{"description":"Additional experimental branding properties.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_PropertyValue"}},"image":{"$ref":"#/components/schemas/youtube_v3_ImageSettings"},"watch":{"$ref":"#/components/schemas/youtube_v3_WatchSettings"}}},"youtube_v3_ChannelContentDetails":{"description":"Details about the content of a channel.","type":"object","properties":{"relatedPlaylists":{"type":"object","properties":{"favorites":{"description":"The ID of the playlist that contains the channel\"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.","type":"string"},"likes":{"description":"The ID of the playlist that contains the channel\"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.","type":"string"},"uploads":{"description":"The ID of the playlist that contains the channel\"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.","type":"string"},"watchHistory":{"description":"The ID of the playlist that contains the channel\"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.","type":"string"},"watchLater":{"description":"The ID of the playlist that contains the channel\"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.","type":"string"}}}}},"youtube_v3_ChannelContentOwnerDetails":{"description":"The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.","type":"object","properties":{"contentOwner":{"description":"The ID of the content owner linked to the channel.","type":"string"},"timeLinked":{"description":"The date and time when the channel was linked to the content owner.","format":"date-time","type":"string"}}},"youtube_v3_ChannelConversionPing":{"description":"Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.","type":"object","properties":{"context":{"description":"Defines the context of the ping.","enum":["subscribe","unsubscribe","cview"],"type":"string"},"conversionUrl":{"description":"The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.","type":"string"}}},"youtube_v3_ChannelConversionPings":{"description":"The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.","type":"object","properties":{"pings":{"description":"Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_ChannelConversionPing"}}}},"youtube_v3_ChannelListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/youtube_v3_Channel"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channelListResponse\".","default":"youtube#channelListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_ChannelLocalization":{"description":"Channel localization setting","type":"object","properties":{"description":{"description":"The localized strings for channel's description.","type":"string"},"title":{"description":"The localized strings for channel's title.","type":"string"}}},"youtube_v3_ChannelProfileDetails":{"type":"object","properties":{"channelId":{"description":"The YouTube channel ID.","type":"string"},"channelUrl":{"description":"The channel's URL.","type":"string"},"displayName":{"description":"The channel's display name.","type":"string"},"profileImageUrl":{"description":"The channels's avatar URL.","type":"string"}}},"youtube_v3_ChannelSection":{"type":"object","properties":{"contentDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelSectionContentDetails"},"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the channel section.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channelSection\".","default":"youtube#channelSection","type":"string"},"localizations":{"description":"Localizations for different languages","type":"object","additionalProperties":{"$ref":"#/components/schemas/youtube_v3_ChannelSectionLocalization"}},"snippet":{"$ref":"#/components/schemas/youtube_v3_ChannelSectionSnippet"},"targeting":{"$ref":"#/components/schemas/youtube_v3_ChannelSectionTargeting"}}},"youtube_v3_ChannelSectionContentDetails":{"description":"Details about a channelsection, including playlists and channels.","type":"object","properties":{"channels":{"description":"The channel ids for type multiple_channels.","type":"array","items":{"type":"string"}},"playlists":{"description":"The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.","type":"array","items":{"type":"string"}}}},"youtube_v3_ChannelSectionListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of ChannelSections that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_ChannelSection"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#channelSectionListResponse\".","default":"youtube#channelSectionListResponse","type":"string"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_ChannelSectionLocalization":{"description":"ChannelSection localization setting","type":"object","properties":{"title":{"description":"The localized strings for channel section's title.","type":"string"}}},"youtube_v3_ChannelSectionSnippet":{"description":"Basic details about a channel section, including title, style and position.","type":"object","properties":{"channelId":{"description":"The ID that YouTube uses to uniquely identify the channel that published the channel section.","type":"string"},"defaultLanguage":{"description":"The language of the channel section's default title and description.","type":"string"},"localized":{"$ref":"#/components/schemas/youtube_v3_ChannelSectionLocalization"},"position":{"description":"The position of the channel section in the channel.","format":"uint32","type":"integer"},"style":{"description":"The style of the channel section.","enum":["channelsectionStyleUnspecified","horizontalRow","verticalList"],"type":"string"},"title":{"description":"The channel section's title for multiple_playlists and multiple_channels.","type":"string"},"type":{"description":"The type of the channel section.","enum":["channelsectionTypeUndefined","singlePlaylist","multiplePlaylists","popularUploads","recentUploads","likes","allPlaylists","likedPlaylists","recentPosts","recentActivity","liveEvents","upcomingEvents","completedEvents","multipleChannels","postedVideos","postedPlaylists","subscriptions"],"type":"string"}}},"youtube_v3_ChannelSectionTargeting":{"description":"ChannelSection targeting setting.","type":"object","properties":{"countries":{"description":"The country the channel section is targeting.","type":"array","items":{"type":"string"}},"languages":{"description":"The language the channel section is targeting.","type":"array","items":{"type":"string"}},"regions":{"description":"The region the channel section is targeting.","type":"array","items":{"type":"string"}}}},"youtube_v3_ChannelSettings":{"description":"Branding properties for the channel view.","type":"object","properties":{"country":{"description":"The country of the channel.","type":"string"},"defaultLanguage":{"type":"string"},"defaultTab":{"description":"Which content tab users should see when viewing the channel.","type":"string"},"description":{"description":"Specifies the channel description.","type":"string"},"featuredChannelsTitle":{"description":"Title for the featured channels tab.","type":"string"},"featuredChannelsUrls":{"description":"The list of featured channels.","type":"array","items":{"type":"string"}},"keywords":{"description":"Lists keywords associated with the channel, comma-separated.","type":"string"},"moderateComments":{"description":"Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.","type":"boolean"},"profileColor":{"description":"A prominent color that can be rendered on this channel page.","type":"string"},"showBrowseView":{"description":"Whether the tab to browse the videos should be displayed.","type":"boolean"},"showRelatedChannels":{"description":"Whether related channels should be proposed.","type":"boolean"},"title":{"description":"Specifies the channel title.","type":"string"},"trackingAnalyticsAccountId":{"description":"The ID for a Google Analytics account to track and measure traffic to the channels.","type":"string"},"unsubscribedTrailer":{"description":"The trailer of the channel, for users that are not subscribers.","type":"string"}}},"youtube_v3_ChannelSnippet":{"description":"Basic details about a channel, including title, description and thumbnails.","type":"object","properties":{"country":{"description":"The country of the channel.","type":"string"},"customUrl":{"description":"The custom url of the channel.","type":"string"},"defaultLanguage":{"description":"The language of the channel's default title and description.","type":"string"},"description":{"description":"The description of the channel.","type":"string"},"localized":{"$ref":"#/components/schemas/youtube_v3_ChannelLocalization"},"publishedAt":{"description":"The date and time that the channel was created.","format":"date-time","type":"string"},"thumbnails":{"$ref":"#/components/schemas/youtube_v3_ThumbnailDetails"},"title":{"description":"The channel's title.","type":"string"}}},"youtube_v3_ChannelStatistics":{"description":"Statistics about a channel: number of subscribers, number of videos in the channel, etc.","type":"object","properties":{"commentCount":{"description":"The number of comments for the channel.","format":"uint64","type":"string"},"hiddenSubscriberCount":{"description":"Whether or not the number of subscribers is shown for this user.","type":"boolean"},"subscriberCount":{"description":"The number of subscribers that the channel has.","format":"uint64","type":"string"},"videoCount":{"description":"The number of videos uploaded to the channel.","format":"uint64","type":"string"},"viewCount":{"description":"The number of times the channel has been viewed.","format":"uint64","type":"string"}}},"youtube_v3_ChannelStatus":{"description":"JSON template for the status part of a channel.","type":"object","properties":{"isChannelMonetizationEnabled":{"description":"Whether the channel is considered ypp monetization enabled. See go/yppornot for more details.","type":"boolean"},"isLinked":{"description":"If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.","type":"boolean"},"longUploadsStatus":{"description":"The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.","enum":["longUploadsUnspecified","allowed","eligible","disallowed"],"type":"string"},"madeForKids":{"type":"boolean"},"privacyStatus":{"description":"Privacy status of the channel.","enum":["public","unlisted","private"],"type":"string"},"selfDeclaredMadeForKids":{"type":"boolean"}}},"youtube_v3_ChannelToAffiliateProgramLinkDetails":{"description":"Information specific to a creator in an affiliate program linked to a YouTube channel.","type":"object","properties":{"merchantId":{"description":"Required. Google Merchant Center ID of the partner.","format":"uint64","type":"string"},"programStatus":{"description":"Required. Affiliate program status.","enum":["affiliateProgramStatusUnspecified","active","inactive"],"type":"string"},"statusUpdateReason":{"description":"Optional. Reason for the last update of the affiliate program status.","type":"string"},"statusUpdateTime":{"description":"Optional. Timestamp when the affiliate program status was last updated.","format":"google-datetime","type":"string"}}},"youtube_v3_ChannelToStoreLinkDetails":{"description":"Information specific to a store on a merchandising platform linked to a YouTube channel.","type":"object","properties":{"billingDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelToStoreLinkDetailsBillingDetails"},"merchantAffiliateProgramDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails"},"merchantId":{"description":"Google Merchant Center id of the store.","format":"uint64","type":"string"},"storeName":{"description":"Name of the store.","type":"string"},"storeUrl":{"description":"Landing page of the store.","type":"string"}}},"youtube_v3_ChannelToStoreLinkDetailsBillingDetails":{"description":"Information specific to billing.","type":"object","properties":{"billingStatus":{"description":"The current billing profile status.","enum":["billingStatusUnspecified","billingStatusPending","billingStatusActive","billingStatusInactive"],"type":"string"}}},"youtube_v3_ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails":{"description":"Information specific to merchant affiliate program.","type":"object","properties":{"status":{"description":"The current merchant affiliate program status.","enum":["merchantAffiliateProgramStatusUnspecified","merchantAffiliateProgramStatusEligible","merchantAffiliateProgramStatusActive","merchantAffiliateProgramStatusPaused"],"type":"string"}}},"youtube_v3_ChannelTopicDetails":{"description":"Freebase topic information related to the channel.","type":"object","properties":{"topicCategories":{"description":"A list of Wikipedia URLs that describe the channel's content.","type":"array","items":{"type":"string"}},"topicIds":{"description":"A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.","type":"array","items":{"type":"string"}}}},"youtube_v3_Comment":{"description":"A *comment* represents a single YouTube comment.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the comment.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#comment\".","default":"youtube#comment","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_CommentSnippet"}}},"youtube_v3_CommentListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of comments that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_Comment"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#commentListResponse\".","default":"youtube#commentListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_CommentSnippet":{"description":"Basic details about a comment, such as its author and text.","type":"object","properties":{"authorChannelId":{"$ref":"#/components/schemas/youtube_v3_CommentSnippetAuthorChannelId"},"authorChannelUrl":{"description":"Link to the author's YouTube channel, if any.","type":"string"},"authorDisplayName":{"description":"The name of the user who posted the comment.","type":"string"},"authorProfileImageUrl":{"description":"The URL for the avatar of the user who posted the comment.","type":"string"},"canRate":{"description":"Whether the current viewer can rate this comment.","type":"boolean"},"channelId":{"description":"The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.","type":"string"},"imageUrl":{"description":"Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval.","readOnly":true,"type":"string"},"likeCount":{"description":"The total number of likes this comment has received.","format":"uint32","type":"integer"},"moderationStatus":{"description":"The comment's moderation status. Will not be set if the comments were requested through the id filter.","enum":["published","heldForReview","likelySpam","rejected"],"type":"string"},"parentId":{"description":"The unique id of the top-level comment, only set for replies.","type":"string"},"publishedAt":{"description":"The date and time when the comment was originally published.","format":"date-time","type":"string"},"textDisplay":{"description":"The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.","type":"string"},"textOriginal":{"description":"The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.","type":"string"},"updatedAt":{"description":"The date and time when the comment was last updated.","format":"date-time","type":"string"},"videoId":{"description":"The ID of the video the comment refers to, if any.","type":"string"},"viewerRating":{"description":"The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.","enum":["none","like","dislike"],"type":"string"}}},"youtube_v3_CommentSnippetAuthorChannelId":{"description":"Contains the id of the author's YouTube channel, if any.","type":"object","properties":{"value":{"description":"The id of the author's YouTube channel.","type":"string"}}},"youtube_v3_CommentThread":{"description":"A *comment thread* represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the comment thread.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#commentThread\".","default":"youtube#commentThread","type":"string"},"replies":{"$ref":"#/components/schemas/youtube_v3_CommentThreadReplies"},"snippet":{"$ref":"#/components/schemas/youtube_v3_CommentThreadSnippet"}}},"youtube_v3_CommentThreadListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of comment threads that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_CommentThread"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#commentThreadListResponse\".","default":"youtube#commentThreadListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_CommentThreadReplies":{"description":"Comments written in (direct or indirect) reply to the top level comment.","type":"object","properties":{"comments":{"description":"A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_Comment"}}}},"youtube_v3_CommentThreadSnippet":{"description":"Basic details about a comment thread.","type":"object","properties":{"canReply":{"description":"Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.","type":"boolean"},"channelId":{"description":"The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If neither video_id nor post_id is set the comments refer to the channel itself.","type":"string"},"isPublic":{"description":"Whether the thread (and therefore all its comments) is visible to all YouTube users.","type":"boolean"},"topLevelComment":{"$ref":"#/components/schemas/youtube_v3_Comment"},"totalReplyCount":{"description":"The total number of replies (not including the top level comment).","format":"uint32","type":"integer"},"videoId":{"description":"The ID of the video the comments refer to, if any.","type":"string"}}},"youtube_v3_ContentRating":{"description":"Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange","type":"object","properties":{"acbRating":{"description":"The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming.","enum":["acbUnspecified","acbE","acbP","acbC","acbG","acbPg","acbM","acbMa15plus","acbR18plus","acbUnrated"],"type":"string"},"agcomRating":{"description":"The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM).","enum":["agcomUnspecified","agcomT","agcomVm14","agcomVm18","agcomUnrated"],"type":"string"},"anatelRating":{"description":"The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television.","enum":["anatelUnspecified","anatelF","anatelI","anatelI7","anatelI10","anatelI12","anatelR","anatelA","anatelUnrated"],"type":"string"},"bbfcRating":{"description":"The video's British Board of Film Classification (BBFC) rating.","enum":["bbfcUnspecified","bbfcU","bbfcPg","bbfc12a","bbfc12","bbfc15","bbfc18","bbfcR18","bbfcUnrated"],"type":"string"},"bfvcRating":{"description":"The video's rating from Thailand's Board of Film and Video Censors.","enum":["bfvcUnspecified","bfvcG","bfvcE","bfvc13","bfvc15","bfvc18","bfvc20","bfvcB","bfvcUnrated"],"type":"string"},"bmukkRating":{"description":"The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur).","enum":["bmukkUnspecified","bmukkAa","bmukk6","bmukk8","bmukk10","bmukk12","bmukk14","bmukk16","bmukkUnrated"],"type":"string"},"catvRating":{"description":"Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.","enum":["catvUnspecified","catvC","catvC8","catvG","catvPg","catv14plus","catv18plus","catvUnrated","catvE"],"type":"string"},"catvfrRating":{"description":"The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.","enum":["catvfrUnspecified","catvfrG","catvfr8plus","catvfr13plus","catvfr16plus","catvfr18plus","catvfrUnrated","catvfrE"],"type":"string"},"cbfcRating":{"description":"The video's Central Board of Film Certification (CBFC - India) rating.","enum":["cbfcUnspecified","cbfcU","cbfcUA","cbfcUA7plus","cbfcUA13plus","cbfcUA16plus","cbfcA","cbfcS","cbfcUnrated"],"type":"string"},"cccRating":{"description":"The video's Consejo de Calificación Cinematográfica (Chile) rating.","enum":["cccUnspecified","cccTe","ccc6","ccc14","ccc18","ccc18v","ccc18s","cccUnrated"],"type":"string"},"cceRating":{"description":"The video's rating from Portugal's Comissão de Classificação de Espect´culos.","enum":["cceUnspecified","cceM4","cceM6","cceM12","cceM16","cceM18","cceUnrated","cceM14"],"type":"string"},"chfilmRating":{"description":"The video's rating in Switzerland.","enum":["chfilmUnspecified","chfilm0","chfilm6","chfilm12","chfilm16","chfilm18","chfilmUnrated"],"type":"string"},"chvrsRating":{"description":"The video's Canadian Home Video Rating System (CHVRS) rating.","enum":["chvrsUnspecified","chvrsG","chvrsPg","chvrs14a","chvrs18a","chvrsR","chvrsE","chvrsUnrated"],"type":"string"},"cicfRating":{"description":"The video's rating from the Commission de Contrôle des Films (Belgium).","enum":["cicfUnspecified","cicfE","cicfKtEa","cicfKntEna","cicfUnrated"],"type":"string"},"cnaRating":{"description":"The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA).","enum":["cnaUnspecified","cnaAp","cna12","cna15","cna18","cna18plus","cnaUnrated"],"type":"string"},"cncRating":{"description":"Rating system in France - Commission de classification cinematographique","enum":["cncUnspecified","cncT","cnc10","cnc12","cnc16","cnc18","cncE","cncInterdiction","cncUnrated"],"type":"string"},"csaRating":{"description":"The video's rating from France's Conseil supérieur de l’audiovisuel, which rates broadcast content.","enum":["csaUnspecified","csaT","csa10","csa12","csa16","csa18","csaInterdiction","csaUnrated"],"type":"string"},"cscfRating":{"description":"The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF).","enum":["cscfUnspecified","cscfAl","cscfA","cscf6","cscf9","cscf12","cscf16","cscf18","cscfUnrated"],"type":"string"},"czfilmRating":{"description":"The video's rating in the Czech Republic.","enum":["czfilmUnspecified","czfilmU","czfilm12","czfilm14","czfilm18","czfilmUnrated"],"type":"string"},"djctqRating":{"description":"The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating.","enum":["djctqUnspecified","djctqL","djctq10","djctq12","djctq14","djctq16","djctq18","djctqEr","djctqL10","djctqL12","djctqL14","djctqL16","djctqL18","djctq1012","djctq1014","djctq1016","djctq1018","djctq1214","djctq1216","djctq1218","djctq1416","djctq1418","djctq1618","djctqUnrated"],"type":"string"},"djctqRatingReasons":{"description":"Reasons that explain why the video received its DJCQT (Brazil) rating.","type":"array","items":{"enum":["djctqRatingReasonUnspecified","djctqViolence","djctqExtremeViolence","djctqSexualContent","djctqNudity","djctqSex","djctqExplicitSex","djctqDrugs","djctqLegalDrugs","djctqIllegalDrugs","djctqInappropriateLanguage","djctqCriminalActs","djctqImpactingContent","djctqFear","djctqMedicalProcedures","djctqSensitiveTopics","djctqFantasyViolence"],"type":"string"}},"ecbmctRating":{"description":"Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism","enum":["ecbmctUnspecified","ecbmctG","ecbmct7a","ecbmct7plus","ecbmct13a","ecbmct13plus","ecbmct15a","ecbmct15plus","ecbmct18plus","ecbmctUnrated"],"type":"string"},"eefilmRating":{"description":"The video's rating in Estonia.","enum":["eefilmUnspecified","eefilmPere","eefilmL","eefilmMs6","eefilmK6","eefilmMs12","eefilmK12","eefilmK14","eefilmK16","eefilmUnrated"],"type":"string"},"egfilmRating":{"description":"The video's rating in Egypt.","enum":["egfilmUnspecified","egfilmGn","egfilm18","egfilmBn","egfilmUnrated"],"type":"string"},"eirinRating":{"description":"The video's Eirin (映倫) rating. Eirin is the Japanese rating system.","enum":["eirinUnspecified","eirinG","eirinPg12","eirinR15plus","eirinR18plus","eirinUnrated"],"type":"string"},"fcbmRating":{"description":"The video's rating from Malaysia's Film Censorship Board.","enum":["fcbmUnspecified","fcbmU","fcbmPg13","fcbmP13","fcbm18","fcbm18sx","fcbm18pa","fcbm18sg","fcbm18pl","fcbmUnrated"],"type":"string"},"fcoRating":{"description":"The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration.","enum":["fcoUnspecified","fcoI","fcoIia","fcoIib","fcoIi","fcoIii","fcoUnrated"],"type":"string"},"fmocRating":{"description":"This property has been deprecated. Use the contentDetails.contentRating.cncRating instead.","enum":["fmocUnspecified","fmocU","fmoc10","fmoc12","fmoc16","fmoc18","fmocE","fmocUnrated"],"type":"string"},"fpbRating":{"description":"The video's rating from South Africa's Film and Publication Board.","enum":["fpbUnspecified","fpbA","fpbPg","fpb79Pg","fpb1012Pg","fpb13","fpb16","fpb18","fpbX18","fpbXx","fpbUnrated","fpb10"],"type":"string"},"fpbRatingReasons":{"description":"Reasons that explain why the video received its FPB (South Africa) rating.","type":"array","items":{"enum":["fpbRatingReasonUnspecified","fpbBlasphemy","fpbLanguage","fpbNudity","fpbPrejudice","fpbSex","fpbViolence","fpbDrugs","fpbSexualViolence","fpbHorror","fpbCriminalTechniques","fpbImitativeActsTechniques"],"type":"string"}},"fskRating":{"description":"The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating.","enum":["fskUnspecified","fsk0","fsk6","fsk12","fsk16","fsk18","fskUnrated"],"type":"string"},"grfilmRating":{"description":"The video's rating in Greece.","enum":["grfilmUnspecified","grfilmK","grfilmE","grfilmK12","grfilmK13","grfilmK15","grfilmK17","grfilmK18","grfilmUnrated"],"type":"string"},"icaaRating":{"description":"The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating.","enum":["icaaUnspecified","icaaApta","icaa7","icaa12","icaa13","icaa16","icaa18","icaaX","icaaUnrated"],"type":"string"},"ifcoRating":{"description":"The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information.","enum":["ifcoUnspecified","ifcoG","ifcoPg","ifco12","ifco12a","ifco15","ifco15a","ifco16","ifco18","ifcoUnrated"],"type":"string"},"ilfilmRating":{"description":"The video's rating in Israel.","enum":["ilfilmUnspecified","ilfilmAa","ilfilm12","ilfilm14","ilfilm16","ilfilm18","ilfilmUnrated"],"type":"string"},"incaaRating":{"description":"The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating.","enum":["incaaUnspecified","incaaAtp","incaaSam13","incaaSam16","incaaSam18","incaaC","incaaUnrated"],"type":"string"},"kfcbRating":{"description":"The video's rating from the Kenya Film Classification Board.","enum":["kfcbUnspecified","kfcbG","kfcbPg","kfcb16plus","kfcbR","kfcbUnrated"],"type":"string"},"kijkwijzerRating":{"description":"The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de Classificatie van Audiovisuele Media (Netherlands).","enum":["kijkwijzerUnspecified","kijkwijzerAl","kijkwijzer6","kijkwijzer9","kijkwijzer12","kijkwijzer16","kijkwijzer18","kijkwijzerUnrated"],"type":"string"},"kmrbRating":{"description":"The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea.","enum":["kmrbUnspecified","kmrbAll","kmrb12plus","kmrb15plus","kmrbTeenr","kmrbR","kmrbUnrated"],"type":"string"},"lsfRating":{"description":"The video's rating from Indonesia's Lembaga Sensor Film.","enum":["lsfUnspecified","lsfSu","lsfA","lsfBo","lsf13","lsfR","lsf17","lsfD","lsf21","lsfUnrated"],"type":"string"},"mccaaRating":{"description":"The video's rating from Malta's Film Age-Classification Board.","enum":["mccaaUnspecified","mccaaU","mccaaPg","mccaa12a","mccaa12","mccaa14","mccaa15","mccaa16","mccaa18","mccaaUnrated"],"type":"string"},"mccypRating":{"description":"The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People.","enum":["mccypUnspecified","mccypA","mccyp7","mccyp11","mccyp15","mccypUnrated"],"type":"string"},"mcstRating":{"description":"The video's rating system for Vietnam - MCST","enum":["mcstUnspecified","mcstP","mcst0","mcstC13","mcstC16","mcst16plus","mcstC18","mcstGPg","mcstUnrated"],"type":"string"},"mdaRating":{"description":"The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC).","enum":["mdaUnspecified","mdaG","mdaPg","mdaPg13","mdaNc16","mdaM18","mdaR21","mdaUnrated"],"type":"string"},"medietilsynetRating":{"description":"The video's rating from Medietilsynet, the Norwegian Media Authority.","enum":["medietilsynetUnspecified","medietilsynetA","medietilsynet6","medietilsynet7","medietilsynet9","medietilsynet11","medietilsynet12","medietilsynet15","medietilsynet18","medietilsynetUnrated"],"type":"string"},"mekuRating":{"description":"The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute).","enum":["mekuUnspecified","mekuS","meku7","meku12","meku16","meku18","mekuUnrated"],"type":"string"},"menaMpaaRating":{"description":"The rating system for MENA countries, a clone of MPAA. It is needed to prevent titles go live w/o additional QC check, since some of them can be inappropriate for the countries at all. See b/33408548 for more details.","enum":["menaMpaaUnspecified","menaMpaaG","menaMpaaPg","menaMpaaPg13","menaMpaaR","menaMpaaUnrated"],"type":"string"},"mibacRating":{"description":"The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy).","enum":["mibacUnspecified","mibacT","mibacVap","mibacVm6","mibacVm12","mibacVm14","mibacVm16","mibacVm18","mibacUnrated"],"type":"string"},"mocRating":{"description":"The video's Ministerio de Cultura (Colombia) rating.","enum":["mocUnspecified","mocE","mocT","moc7","moc12","moc15","moc18","mocX","mocBanned","mocUnrated"],"type":"string"},"moctwRating":{"description":"The video's rating from Taiwan's Ministry of Culture (文化部).","enum":["moctwUnspecified","moctwG","moctwP","moctwPg","moctwR","moctwUnrated","moctwR12","moctwR15"],"type":"string"},"mpaaRating":{"description":"The video's Motion Picture Association of America (MPAA) rating.","enum":["mpaaUnspecified","mpaaG","mpaaPg","mpaaPg13","mpaaR","mpaaNc17","mpaaX","mpaaUnrated"],"type":"string"},"mpaatRating":{"description":"The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html.","enum":["mpaatUnspecified","mpaatGb","mpaatRb"],"type":"string"},"mtrcbRating":{"description":"The video's rating from the Movie and Television Review and Classification Board (Philippines).","enum":["mtrcbUnspecified","mtrcbG","mtrcbPg","mtrcbR13","mtrcbR16","mtrcbR18","mtrcbX","mtrcbUnrated"],"type":"string"},"nbcRating":{"description":"The video's rating from the Maldives National Bureau of Classification.","enum":["nbcUnspecified","nbcG","nbcPg","nbc12plus","nbc15plus","nbc18plus","nbc18plusr","nbcPu","nbcUnrated"],"type":"string"},"nbcplRating":{"description":"The video's rating in Poland.","enum":["nbcplUnspecified","nbcplI","nbcplIi","nbcplIii","nbcplIv","nbcpl18plus","nbcplUnrated"],"type":"string"},"nfrcRating":{"description":"The video's rating from the Bulgarian National Film Center.","enum":["nfrcUnspecified","nfrcA","nfrcB","nfrcC","nfrcD","nfrcX","nfrcUnrated"],"type":"string"},"nfvcbRating":{"description":"The video's rating from Nigeria's National Film and Video Censors Board.","enum":["nfvcbUnspecified","nfvcbG","nfvcbPg","nfvcb12","nfvcb12a","nfvcb15","nfvcb18","nfvcbRe","nfvcbUnrated"],"type":"string"},"nkclvRating":{"description":"The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia).","enum":["nkclvUnspecified","nkclvU","nkclv7plus","nkclv12plus","nkclv16plus","nkclv18plus","nkclvUnrated"],"type":"string"},"nmcRating":{"description":"The National Media Council ratings system for United Arab Emirates.","enum":["nmcUnspecified","nmcG","nmcPg","nmcPg13","nmcPg15","nmc15plus","nmc18plus","nmc18tc","nmcUnrated"],"type":"string"},"oflcRating":{"description":"The video's Office of Film and Literature Classification (OFLC - New Zealand) rating.","enum":["oflcUnspecified","oflcG","oflcPg","oflcM","oflcR13","oflcR15","oflcR16","oflcR18","oflcUnrated","oflcRp13","oflcRp16","oflcRp18"],"type":"string"},"pefilmRating":{"description":"The video's rating in Peru.","enum":["pefilmUnspecified","pefilmPt","pefilmPg","pefilm14","pefilm18","pefilmUnrated"],"type":"string"},"rcnofRating":{"description":"The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film.","enum":["rcnofUnspecified","rcnofI","rcnofIi","rcnofIii","rcnofIv","rcnofV","rcnofVi","rcnofUnrated"],"type":"string"},"resorteviolenciaRating":{"description":"The video's rating in Venezuela.","enum":["resorteviolenciaUnspecified","resorteviolenciaA","resorteviolenciaB","resorteviolenciaC","resorteviolenciaD","resorteviolenciaE","resorteviolenciaUnrated"],"type":"string"},"rtcRating":{"description":"The video's General Directorate of Radio, Television and Cinematography (Mexico) rating.","enum":["rtcUnspecified","rtcAa","rtcA","rtcB","rtcB15","rtcC","rtcD","rtcUnrated"],"type":"string"},"rteRating":{"description":"The video's rating from Ireland's Raidió Teilifís Éireann.","enum":["rteUnspecified","rteGa","rteCh","rtePs","rteMa","rteUnrated"],"type":"string"},"russiaRating":{"description":"The video's National Film Registry of the Russian Federation (MKRF - Russia) rating.","enum":["russiaUnspecified","russia0","russia6","russia12","russia16","russia18","russiaUnrated"],"type":"string"},"skfilmRating":{"description":"The video's rating in Slovakia.","enum":["skfilmUnspecified","skfilmG","skfilmP2","skfilmP5","skfilmP8","skfilmUnrated"],"type":"string"},"smaisRating":{"description":"The video's rating in Iceland.","enum":["smaisUnspecified","smaisL","smais7","smais12","smais14","smais16","smais18","smaisUnrated"],"type":"string"},"smsaRating":{"description":"The video's rating from Statens medieråd (Sweden's National Media Council).","enum":["smsaUnspecified","smsaA","smsa7","smsa11","smsa15","smsaUnrated"],"type":"string"},"tvpgRating":{"description":"The video's TV Parental Guidelines (TVPG) rating.","enum":["tvpgUnspecified","tvpgY","tvpgY7","tvpgY7Fv","tvpgG","tvpgPg","pg14","tvpgMa","tvpgUnrated"],"type":"string"},"ytRating":{"description":"A rating that YouTube uses to identify age-restricted content.","enum":["ytUnspecified","ytAgeRestricted"],"type":"string"}}},"youtube_v3_Cuepoint":{"description":"Note that there may be a 5-second end-point resolution issue. For instance, if a cuepoint comes in for 22:03:27, we may stuff the cuepoint into 22:03:25 or 22:03:30, depending. This is an artifact of HLS.","type":"object","properties":{"cueType":{"enum":["cueTypeUnspecified","cueTypeAd"],"type":"string"},"durationSecs":{"description":"The duration of this cuepoint.","format":"uint32","type":"integer"},"etag":{"type":"string"},"id":{"description":"The identifier for cuepoint resource.","type":"string"},"insertionOffsetTimeMs":{"description":"The time when the cuepoint should be inserted by offset to the broadcast actual start time.","format":"int64","type":"string"},"walltimeMs":{"description":"The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.","format":"uint64","type":"string"}}},"youtube_v3_CuepointSchedule":{"description":"Schedule to insert cuepoints into a broadcast by ads automator.","type":"object","properties":{"enabled":{"description":"This field is semantically required. If it is set false or not set, other fields in this message will be ignored.","type":"boolean"},"pauseAdsUntil":{"description":"If set, automatic cuepoint insertion is paused until this timestamp (\"No Ad Zone\"). The value is specified in ISO 8601 format.","type":"string"},"repeatIntervalSecs":{"description":"Interval frequency in seconds that api uses to insert cuepoints automatically.","format":"int32","type":"integer"},"scheduleStrategy":{"description":"The strategy to use when scheduling cuepoints.","enum":["scheduleStrategyUnspecified","concurrent","nonConcurrent"],"type":"string"}}},"youtube_v3_Entity":{"type":"object","properties":{"id":{"type":"string"},"typeId":{"type":"string"},"url":{"type":"string"}}},"youtube_v3_GeoPoint":{"description":"Geographical coordinates of a point, in WGS84.","type":"object","properties":{"altitude":{"description":"Altitude above the reference ellipsoid, in meters.","format":"double","type":"number"},"latitude":{"description":"Latitude in degrees.","format":"double","type":"number"},"longitude":{"description":"Longitude in degrees.","format":"double","type":"number"}}},"youtube_v3_I18nLanguage":{"description":"An *i18nLanguage* resource identifies a UI language currently supported by YouTube.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the i18n language.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#i18nLanguage\".","default":"youtube#i18nLanguage","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_I18nLanguageSnippet"}}},"youtube_v3_I18nLanguageListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of supported i18n languages. In this map, the i18n language ID is the map key, and its value is the corresponding i18nLanguage resource.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_I18nLanguage"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#i18nLanguageListResponse\".","default":"youtube#i18nLanguageListResponse","type":"string"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_I18nLanguageSnippet":{"description":"Basic details about an i18n language, such as language code and human-readable name.","type":"object","properties":{"hl":{"description":"A short BCP-47 code that uniquely identifies a language.","type":"string"},"name":{"description":"The human-readable name of the language in the language itself.","type":"string"}}},"youtube_v3_I18nRegion":{"description":"A *i18nRegion* resource identifies a region where YouTube is available.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the i18n region.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#i18nRegion\".","default":"youtube#i18nRegion","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_I18nRegionSnippet"}}},"youtube_v3_I18nRegionListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of regions where YouTube is available. In this map, the i18n region ID is the map key, and its value is the corresponding i18nRegion resource.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_I18nRegion"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#i18nRegionListResponse\".","default":"youtube#i18nRegionListResponse","type":"string"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_I18nRegionSnippet":{"description":"Basic details about an i18n region, such as region code and human-readable name.","type":"object","properties":{"gl":{"description":"The region code as a 2-letter ISO country code.","type":"string"},"name":{"description":"The human-readable name of the region.","type":"string"}}},"youtube_v3_ImageSettings":{"description":"Branding properties for images associated with the channel.","type":"object","properties":{"backgroundImageUrl":{"$ref":"#/components/schemas/youtube_v3_LocalizedProperty"},"bannerExternalUrl":{"description":"This is generated when a ChannelBanner.Insert request has succeeded for the given channel.","type":"string"},"bannerImageUrl":{"description":"Banner image. Desktop size (1060x175).","type":"string"},"bannerMobileExtraHdImageUrl":{"description":"Banner image. Mobile size high resolution (1440x395).","type":"string"},"bannerMobileHdImageUrl":{"description":"Banner image. Mobile size high resolution (1280x360).","type":"string"},"bannerMobileImageUrl":{"description":"Banner image. Mobile size (640x175).","type":"string"},"bannerMobileLowImageUrl":{"description":"Banner image. Mobile size low resolution (320x88).","type":"string"},"bannerMobileMediumHdImageUrl":{"description":"Banner image. Mobile size medium/high resolution (960x263).","type":"string"},"bannerTabletExtraHdImageUrl":{"description":"Banner image. Tablet size extra high resolution (2560x424).","type":"string"},"bannerTabletHdImageUrl":{"description":"Banner image. Tablet size high resolution (2276x377).","type":"string"},"bannerTabletImageUrl":{"description":"Banner image. Tablet size (1707x283).","type":"string"},"bannerTabletLowImageUrl":{"description":"Banner image. Tablet size low resolution (1138x188).","type":"string"},"bannerTvHighImageUrl":{"description":"Banner image. TV size high resolution (1920x1080).","type":"string"},"bannerTvImageUrl":{"description":"Banner image. TV size extra high resolution (2120x1192).","type":"string"},"bannerTvLowImageUrl":{"description":"Banner image. TV size low resolution (854x480).","type":"string"},"bannerTvMediumImageUrl":{"description":"Banner image. TV size medium resolution (1280x720).","type":"string"},"largeBrandedBannerImageImapScript":{"$ref":"#/components/schemas/youtube_v3_LocalizedProperty"},"largeBrandedBannerImageUrl":{"$ref":"#/components/schemas/youtube_v3_LocalizedProperty"},"smallBrandedBannerImageImapScript":{"$ref":"#/components/schemas/youtube_v3_LocalizedProperty"},"smallBrandedBannerImageUrl":{"$ref":"#/components/schemas/youtube_v3_LocalizedProperty"},"trackingImageUrl":{"description":"The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.","type":"string"},"watchIconImageUrl":{"type":"string"}}},"youtube_v3_IngestionInfo":{"description":"Describes information necessary for ingesting an RTMP, HTTP, or SRT stream.","type":"object","properties":{"backupIngestionAddress":{"description":"The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.","type":"string"},"ingestionAddress":{"description":"The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format: *STREAM_URL/STREAM_NAME* ","type":"string"},"rtmpsBackupIngestionAddress":{"description":"This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.","type":"string"},"rtmpsIngestionAddress":{"description":"This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.","type":"string"},"streamName":{"description":"The stream name that YouTube assigns to the video stream.","type":"string"}}},"youtube_v3_Interval":{"description":"Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.","type":"object","properties":{"endTime":{"description":"Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.","format":"google-datetime","type":"string"},"startTime":{"description":"Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.","format":"google-datetime","type":"string"}}},"youtube_v3_InvideoBranding":{"description":"Describes an invideo branding.","type":"object","properties":{"imageBytes":{"description":"The bytes the uploaded image. Only used in api to youtube communication.","format":"byte","type":"string"},"imageUrl":{"description":"The url of the uploaded image. Only used in apiary to api communication.","type":"string"},"position":{"$ref":"#/components/schemas/youtube_v3_InvideoPosition"},"targetChannelId":{"description":"The channel to which this branding links. If not present it defaults to the current channel.","type":"string"},"timing":{"$ref":"#/components/schemas/youtube_v3_InvideoTiming"}}},"youtube_v3_InvideoPosition":{"description":"Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one.","type":"object","properties":{"cornerPosition":{"description":"Describes in which corner of the video the visual widget will appear.","enum":["topLeft","topRight","bottomLeft","bottomRight"],"type":"string"},"type":{"description":"Defines the position type.","enum":["corner"],"type":"string"}}},"youtube_v3_InvideoTiming":{"description":"Describes a temporal position of a visual widget inside a video.","type":"object","properties":{"durationMs":{"description":"Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.","format":"uint64","type":"string"},"offsetMs":{"description":"Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.","format":"uint64","type":"string"},"type":{"description":"Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.","enum":["offsetFromStart","offsetFromEnd"],"type":"string"}}},"youtube_v3_LanguageTag":{"type":"object","properties":{"value":{"type":"string"}}},"youtube_v3_LevelDetails":{"type":"object","properties":{"displayName":{"description":"The name that should be used when referring to this level.","type":"string"}}},"youtube_v3_LiveBroadcast":{"description":"A *liveBroadcast* resource represents an event that will be streamed, via live video, on YouTube.","type":"object","properties":{"contentDetails":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcastContentDetails"},"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube assigns to uniquely identify the broadcast.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveBroadcast\".","default":"youtube#liveBroadcast","type":"string"},"monetizationDetails":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcastMonetizationDetails"},"snippet":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcastSnippet"},"statistics":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcastStatistics"},"status":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcastStatus"}}},"youtube_v3_LiveBroadcastContentDetails":{"description":"Detailed settings of a broadcast.","type":"object","properties":{"availabilityConfig":{"$ref":"#/components/schemas/youtube_v3_AvailabilityConfig"},"boundStreamId":{"description":"This value uniquely identifies the live stream bound to the broadcast.","type":"string"},"boundStreamLastUpdateTimeMs":{"description":"The date and time that the live stream referenced by boundStreamId was last updated.","format":"date-time","type":"string"},"closedCaptionsType":{"enum":["closedCaptionsTypeUnspecified","closedCaptionsDisabled","closedCaptionsHttpPost","closedCaptionsEmbedded"],"type":"string"},"enableAutoStart":{"description":"This setting indicates whether auto start is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.","type":"boolean"},"enableAutoStop":{"description":"This setting indicates whether auto stop is enabled for this broadcast. The default value for this property is false. This setting can only be used by Events.","type":"boolean"},"enableClosedCaptions":{"description":"This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.","type":"boolean"},"enableContentEncryption":{"description":"This setting indicates whether YouTube should enable content encryption for the broadcast.","type":"boolean"},"enableDvr":{"description":"This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. *Important:* You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.","type":"boolean"},"enableEmbed":{"description":"This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.","type":"boolean"},"enableLowLatency":{"description":"Indicates whether this broadcast has low latency enabled.","type":"boolean"},"latencyPreference":{"description":"If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted.","enum":["latencyPreferenceUnspecified","normal","low","ultraLow"],"type":"string"},"mesh":{"description":"The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags.","format":"byte","type":"string"},"monitorStream":{"$ref":"#/components/schemas/youtube_v3_MonitorStreamInfo"},"projection":{"description":"The projection format of this broadcast. This defaults to rectangular.","enum":["projectionUnspecified","rectangular","360","mesh"],"type":"string"},"recordFromStart":{"description":"Automatically start recording after the event goes live. The default value for this property is true. *Important:* You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.","type":"boolean"},"startWithSlate":{"description":"This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.","type":"boolean"},"stereoLayout":{"description":"The 3D stereo layout of this broadcast. This defaults to mono.","enum":["stereoLayoutUnspecified","mono","leftRight","topBottom"],"type":"string"}}},"youtube_v3_LiveBroadcastListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of broadcasts that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_LiveBroadcast"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveBroadcastListResponse\".","default":"youtube#liveBroadcastListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_LiveBroadcastMonetizationDetails":{"description":"Monetization settings of a broadcast.","type":"object","properties":{"cuepointSchedule":{"$ref":"#/components/schemas/youtube_v3_CuepointSchedule"}}},"youtube_v3_LiveBroadcastSnippet":{"description":"Basic broadcast information.","type":"object","properties":{"actualEndTime":{"description":"The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.","format":"date-time","type":"string"},"actualStartTime":{"description":"The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.","format":"date-time","type":"string"},"categoryId":{"description":"The YouTube video category associated with the video broadcast.","type":"string"},"channelId":{"description":"The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.","type":"string"},"description":{"description":"The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.","type":"string"},"isDefaultBroadcast":{"description":"Indicates whether this broadcast is the default broadcast. Internal only.","type":"boolean"},"liveChatId":{"description":"The id of the live chat for this broadcast.","type":"string"},"publishedAt":{"description":"The date and time that the broadcast was added to YouTube's live broadcast schedule.","format":"date-time","type":"string"},"scheduledEndTime":{"description":"The date and time that the broadcast is scheduled to end.","format":"date-time","type":"string"},"scheduledStartTime":{"description":"The date and time that the broadcast is scheduled to start.","format":"date-time","type":"string"},"thumbnails":{"$ref":"#/components/schemas/youtube_v3_ThumbnailDetails"},"title":{"description":"The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.","type":"string"}}},"youtube_v3_LiveBroadcastStatistics":{"description":"Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts.","type":"object","properties":{"concurrentViewers":{"description":"The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.","format":"uint64","type":"string"}}},"youtube_v3_LiveBroadcastStatus":{"description":"Live broadcast state.","type":"object","properties":{"lifeCycleStatus":{"description":"The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.","enum":["lifeCycleStatusUnspecified","created","ready","testing","live","complete","revoked","testStarting","liveStarting"],"type":"string"},"liveBroadcastPriority":{"description":"Priority of the live broadcast event (internal state).","enum":["liveBroadcastPriorityUnspecified","low","normal","high"],"type":"string"},"madeForKids":{"description":"Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only.","type":"boolean"},"privacyStatus":{"description":"The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.","enum":["public","unlisted","private"],"type":"string"},"recordingStatus":{"description":"The broadcast's recording status.","enum":["liveBroadcastRecordingStatusUnspecified","notRecording","recording","recorded"],"type":"string"},"selfDeclaredMadeForKids":{"description":"This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work.","type":"boolean"}}},"youtube_v3_LiveChatBan":{"description":"A `__liveChatBan__` resource represents a ban for a YouTube live chat.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube assigns to uniquely identify the ban.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string `\"youtube#liveChatBan\"`.","default":"youtube#liveChatBan","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_LiveChatBanSnippet"}}},"youtube_v3_LiveChatBanSnippet":{"type":"object","properties":{"banDurationSeconds":{"description":"The duration of a ban, only filled if the ban has type TEMPORARY.","format":"uint64","type":"string"},"bannedUserDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelProfileDetails"},"liveChatId":{"description":"The chat this ban is pertinent to.","type":"string"},"type":{"description":"The type of ban.","enum":["liveChatBanTypeUnspecified","permanent","temporary"],"type":"string"}}},"youtube_v3_LiveChatFanFundingEventDetails":{"type":"object","properties":{"amountDisplayString":{"description":"A rendered string that displays the fund amount and currency to the user.","type":"string"},"amountMicros":{"description":"The amount of the fund.","format":"uint64","type":"string"},"currency":{"description":"The currency in which the fund was made.","type":"string"},"userComment":{"description":"The comment added by the user to this fan funding event.","type":"string"}}},"youtube_v3_LiveChatGiftDetails":{"description":"Details about the gift event, this is only set if the type is 'giftEvent'.","type":"object","properties":{"altText":{"description":"The alternative text to be used for accessibility.","type":"string"},"comboCount":{"description":"The number of times the gift has been sent in a row.","format":"int32","type":"integer"},"giftDuration":{"description":"The duration of the gift.","format":"google-duration","type":"string"},"giftName":{"description":"The name of the gift.","type":"string"},"giftUrl":{"description":"The URL of the gift image.","type":"string"},"hasVisualEffect":{"description":"Whether the gift involves a visual effect.","type":"boolean"},"jewelsAmount":{"description":"The value of the gift in jewels.","format":"int32","type":"integer"},"language":{"description":"The BCP-47 language code of the gift.","type":"string"}}},"youtube_v3_LiveChatGiftMembershipReceivedDetails":{"type":"object","properties":{"associatedMembershipGiftingMessageId":{"description":"The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.","type":"string"},"gifterChannelId":{"description":"The ID of the user that made the membership gifting purchase. This matches the `snippet.authorChannelId` of the associated membership gifting message.","type":"string"},"memberLevelName":{"description":"The name of the Level at which the viewer is a member. This matches the `snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.","type":"string"}}},"youtube_v3_LiveChatMemberMilestoneChatDetails":{"type":"object","properties":{"memberLevelName":{"description":"The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.","type":"string"},"memberMonth":{"description":"The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.","format":"uint32","type":"integer"},"userComment":{"description":"The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.","type":"string"}}},"youtube_v3_LiveChatMembershipGiftingDetails":{"type":"object","properties":{"giftMembershipsCount":{"description":"The number of gift memberships purchased by the user.","format":"int32","type":"integer"},"giftMembershipsLevelName":{"description":"The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.","type":"string"}}},"youtube_v3_LiveChatMessage":{"description":"A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.","type":"object","properties":{"authorDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessageAuthorDetails"},"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube assigns to uniquely identify the message.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatMessage\".","default":"youtube#liveChatMessage","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessageSnippet"}}},"youtube_v3_LiveChatMessageAuthorDetails":{"type":"object","properties":{"channelId":{"description":"The YouTube channel ID.","type":"string"},"channelUrl":{"description":"The channel's URL.","type":"string"},"displayName":{"description":"The channel's display name.","type":"string"},"isChatModerator":{"description":"Whether the author is a moderator of the live chat.","type":"boolean"},"isChatOwner":{"description":"Whether the author is the owner of the live chat.","type":"boolean"},"isChatSponsor":{"description":"Whether the author is a sponsor of the live chat.","type":"boolean"},"isVerified":{"description":"Whether the author's identity has been verified by YouTube.","type":"boolean"},"profileImageUrl":{"description":"The channels's avatar URL.","type":"string"}}},"youtube_v3_LiveChatMessageDeletedDetails":{"type":"object","properties":{"deletedMessageId":{"type":"string"}}},"youtube_v3_LiveChatMessageListResponse":{"type":"object","properties":{"activePollItem":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessage"},"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessage"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatMessageListResponse\".","default":"youtube#liveChatMessageListResponse","type":"string"},"nextPageToken":{"type":"string"},"offlineAt":{"description":"The date and time when the underlying stream went offline.","format":"date-time","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"pollingIntervalMillis":{"description":"The amount of time the client should wait before polling again.","format":"uint32","type":"integer"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_LiveChatMessageRetractedDetails":{"type":"object","properties":{"retractedMessageId":{"type":"string"}}},"youtube_v3_LiveChatMessageSnippet":{"description":"Next ID: 35","type":"object","properties":{"authorChannelId":{"description":"The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll","type":"string"},"displayMessage":{"description":"Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.","type":"string"},"fanFundingEventDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatFanFundingEventDetails"},"giftDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatGiftDetails"},"giftMembershipReceivedDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatGiftMembershipReceivedDetails"},"hasDisplayContent":{"description":"Whether the message has display content that should be displayed to users.","type":"boolean"},"liveChatId":{"type":"string"},"memberMilestoneChatDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatMemberMilestoneChatDetails"},"membershipGiftingDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatMembershipGiftingDetails"},"messageDeletedDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessageDeletedDetails"},"messageRetractedDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatMessageRetractedDetails"},"newSponsorDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatNewSponsorDetails"},"pollDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatPollDetails"},"publishedAt":{"description":"The date and time when the message was orignally published.","format":"date-time","type":"string"},"superChatDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatSuperChatDetails"},"superStickerDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatSuperStickerDetails"},"textMessageDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatTextMessageDetails"},"type":{"description":"The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.","enum":["invalidType","textMessageEvent","tombstone","fanFundingEvent","chatEndedEvent","sponsorOnlyModeStartedEvent","sponsorOnlyModeEndedEvent","newSponsorEvent","memberMilestoneChatEvent","membershipGiftingEvent","giftMembershipReceivedEvent","messageDeletedEvent","messageRetractedEvent","userBannedEvent","superChatEvent","superStickerEvent","pollEvent","giftEvent"],"type":"string"},"userBannedDetails":{"$ref":"#/components/schemas/youtube_v3_LiveChatUserBannedMessageDetails"}}},"youtube_v3_LiveChatModerator":{"description":"A *liveChatModerator* resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube assigns to uniquely identify the moderator.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatModerator\".","default":"youtube#liveChatModerator","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_LiveChatModeratorSnippet"}}},"youtube_v3_LiveChatModeratorListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of moderators that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_LiveChatModerator"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatModeratorListResponse\".","default":"youtube#liveChatModeratorListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_LiveChatModeratorSnippet":{"type":"object","properties":{"liveChatId":{"description":"The ID of the live chat this moderator can act on.","type":"string"},"moderatorDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelProfileDetails"}}},"youtube_v3_LiveChatNewSponsorDetails":{"type":"object","properties":{"isUpgrade":{"description":"If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.","type":"boolean"},"memberLevelName":{"description":"The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled.","type":"string"}}},"youtube_v3_LiveChatPollDetails":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/youtube_v3_LiveChatPollDetailsPollMetadata"},"status":{"enum":["unknown","active","closed"],"type":"string"}}},"youtube_v3_LiveChatPollDetailsPollMetadata":{"type":"object","properties":{"options":{"description":"The options will be returned in the order that is displayed in 1P","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_LiveChatPollDetailsPollMetadataPollOption"}},"questionText":{"type":"string"}}},"youtube_v3_LiveChatPollDetailsPollMetadataPollOption":{"type":"object","properties":{"optionText":{"type":"string"},"tally":{"format":"int64","type":"string"}}},"youtube_v3_LiveChatSuperChatDetails":{"type":"object","properties":{"amountDisplayString":{"description":"A rendered string that displays the fund amount and currency to the user.","type":"string"},"amountMicros":{"description":"The amount purchased by the user, in micros (1,750,000 micros = 1.75).","format":"uint64","type":"string"},"currency":{"description":"The currency in which the purchase was made.","type":"string"},"tier":{"description":"The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.","format":"uint32","type":"integer"},"userComment":{"description":"The comment added by the user to this Super Chat event.","type":"string"}}},"youtube_v3_LiveChatSuperStickerDetails":{"type":"object","properties":{"amountDisplayString":{"description":"A rendered string that displays the fund amount and currency to the user.","type":"string"},"amountMicros":{"description":"The amount purchased by the user, in micros (1,750,000 micros = 1.75).","format":"uint64","type":"string"},"currency":{"description":"The currency in which the purchase was made.","type":"string"},"superStickerMetadata":{"$ref":"#/components/schemas/youtube_v3_SuperStickerMetadata"},"tier":{"description":"The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.","format":"uint32","type":"integer"}}},"youtube_v3_LiveChatTextMessageDetails":{"type":"object","properties":{"messageText":{"description":"The user's message.","type":"string"}}},"youtube_v3_LiveChatUserBannedMessageDetails":{"type":"object","properties":{"banDurationSeconds":{"description":"The duration of the ban. This property is only present if the banType is temporary.","format":"uint64","type":"string"},"banType":{"description":"The type of ban.","enum":["permanent","temporary"],"type":"string"},"bannedUserDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelProfileDetails"}}},"youtube_v3_LiveStream":{"description":"A live stream describes a live ingestion point.","type":"object","properties":{"cdn":{"$ref":"#/components/schemas/youtube_v3_CdnSettings"},"contentDetails":{"$ref":"#/components/schemas/youtube_v3_LiveStreamContentDetails"},"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube assigns to uniquely identify the stream.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveStream\".","default":"youtube#liveStream","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_LiveStreamSnippet"},"status":{"$ref":"#/components/schemas/youtube_v3_LiveStreamStatus"}}},"youtube_v3_LiveStreamConfigurationIssue":{"type":"object","properties":{"description":{"description":"The long-form description of the issue and how to resolve it.","type":"string"},"reason":{"description":"The short-form reason for this issue.","type":"string"},"severity":{"description":"How severe this issue is to the stream.","enum":["info","warning","error"],"type":"string"},"type":{"description":"The kind of error happening.","enum":["gopSizeOver","gopSizeLong","gopSizeShort","openGop","badContainer","audioBitrateHigh","audioBitrateLow","audioSampleRate","bitrateHigh","bitrateLow","audioCodec","videoCodec","noAudioStream","noVideoStream","multipleVideoStreams","multipleAudioStreams","audioTooManyChannels","interlacedVideo","frameRateHigh","resolutionMismatch","videoCodecMismatch","videoInterlaceMismatch","videoProfileMismatch","videoBitrateMismatch","framerateMismatch","gopMismatch","audioSampleRateMismatch","audioStereoMismatch","audioCodecMismatch","audioBitrateMismatch","videoResolutionSuboptimal","videoResolutionUnsupported","videoIngestionStarved","videoIngestionFasterThanRealtime"],"type":"string"}}},"youtube_v3_LiveStreamContentDetails":{"description":"Detailed settings of a stream.","type":"object","properties":{"closedCaptionsIngestionUrl":{"description":"The ingestion URL where the closed captions of this stream are sent.","type":"string"},"isReusable":{"description":"Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times. If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream. ","type":"boolean"}}},"youtube_v3_LiveStreamHealthStatus":{"type":"object","properties":{"configurationIssues":{"description":"The configurations issues on this stream","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_LiveStreamConfigurationIssue"}},"lastUpdateTimeSeconds":{"description":"The last time this status was updated (in seconds)","format":"uint64","type":"string"},"status":{"description":"The status code of this stream","enum":["good","ok","bad","noData","revoked"],"type":"string"}}},"youtube_v3_LiveStreamListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of live streams that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_LiveStream"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#liveStreamListResponse\".","default":"youtube#liveStreamListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_LiveStreamSnippet":{"type":"object","properties":{"channelId":{"description":"The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.","type":"string"},"description":{"description":"The stream's description. The value cannot be longer than 10000 characters.","type":"string"},"isDefaultStream":{"type":"boolean"},"publishedAt":{"description":"The date and time that the stream was created.","format":"date-time","type":"string"},"title":{"description":"The stream's title. The value must be between 1 and 128 characters long.","type":"string"}}},"youtube_v3_LiveStreamStatus":{"description":"Brief description of the live stream status.","type":"object","properties":{"healthStatus":{"$ref":"#/components/schemas/youtube_v3_LiveStreamHealthStatus"},"streamStatus":{"enum":["created","ready","active","inactive","error"],"type":"string"}}},"youtube_v3_LocalizedProperty":{"type":"object","properties":{"default":{"type":"string"},"defaultLanguage":{"$ref":"#/components/schemas/youtube_v3_LanguageTag"},"localized":{"type":"array","items":{"$ref":"#/components/schemas/youtube_v3_LocalizedString"}}}},"youtube_v3_LocalizedString":{"type":"object","properties":{"language":{"type":"string"},"value":{"type":"string"}}},"youtube_v3_Member":{"description":"A *member* resource represents a member for a YouTube channel. A member provides recurring monetary support to a creator and receives special benefits.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#member\".","default":"youtube#member","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_MemberSnippet"}}},"youtube_v3_MemberListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of members that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_Member"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#memberListResponse\".","default":"youtube#memberListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_MemberSnippet":{"type":"object","properties":{"creatorChannelId":{"description":"The id of the channel that's offering memberships.","type":"string"},"memberDetails":{"$ref":"#/components/schemas/youtube_v3_ChannelProfileDetails"},"membershipsDetails":{"$ref":"#/components/schemas/youtube_v3_MembershipsDetails"}}},"youtube_v3_MembershipsDetails":{"type":"object","properties":{"accessibleLevels":{"description":"Ids of all levels that the user has access to. This includes the currently active level and all other levels that are included because of a higher purchase.","type":"array","items":{"type":"string"}},"highestAccessibleLevel":{"description":"Id of the highest level that the user has access to at the moment.","type":"string"},"highestAccessibleLevelDisplayName":{"description":"Display name for the highest level that the user has access to at the moment.","type":"string"},"membershipsDuration":{"$ref":"#/components/schemas/youtube_v3_MembershipsDuration"},"membershipsDurationAtLevels":{"description":"Data about memberships duration on particular pricing levels.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_MembershipsDurationAtLevel"}}}},"youtube_v3_MembershipsDuration":{"type":"object","properties":{"memberSince":{"description":"The date and time when the user became a continuous member across all levels.","type":"string"},"memberTotalDurationMonths":{"description":"The cumulative time the user has been a member across all levels in complete months (the time is rounded down to the nearest integer).","format":"int32","type":"integer"}}},"youtube_v3_MembershipsDurationAtLevel":{"type":"object","properties":{"level":{"description":"Pricing level ID.","type":"string"},"memberSince":{"description":"The date and time when the user became a continuous member for the given level.","type":"string"},"memberTotalDurationMonths":{"description":"The cumulative time the user has been a member for the given level in complete months (the time is rounded down to the nearest integer).","format":"int32","type":"integer"}}},"youtube_v3_MembershipsLevel":{"description":"A *membershipsLevel* resource represents an offer made by YouTube creators for their fans. Users can become members of the channel by joining one of the available levels. They will provide recurring monetary support and receives special benefits.","type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube assigns to uniquely identify the memberships level.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#membershipsLevelListResponse\".","default":"youtube#membershipsLevel","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_MembershipsLevelSnippet"}}},"youtube_v3_MembershipsLevelListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of pricing levels offered by a creator to the fans.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_MembershipsLevel"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#membershipsLevelListResponse\".","default":"youtube#membershipsLevelListResponse","type":"string"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_MembershipsLevelSnippet":{"type":"object","properties":{"creatorChannelId":{"description":"The id of the channel that's offering channel memberships.","type":"string"},"levelDetails":{"$ref":"#/components/schemas/youtube_v3_LevelDetails"}}},"youtube_v3_MonitorStreamInfo":{"description":"Settings and Info of the monitor stream","type":"object","properties":{"broadcastStreamDelayMs":{"description":"If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.","format":"uint32","type":"integer"},"embedHtml":{"description":"HTML code that embeds a player that plays the monitor stream.","type":"string"},"enableMonitorStream":{"description":"This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. *Note:* This property cannot be updated once the broadcast is in the testing or live state.","type":"boolean"}}},"youtube_v3_PageInfo":{"description":"Paging details for lists of resources, including total number of items available and number of resources returned in a single page.","type":"object","properties":{"resultsPerPage":{"description":"The number of results included in the API response.","format":"int32","type":"integer"},"totalResults":{"description":"The total number of results in the result set.","format":"int32","type":"integer"}}},"youtube_v3_Playlist":{"description":"A *playlist* resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private. YouTube also uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.","type":"object","properties":{"contentDetails":{"$ref":"#/components/schemas/youtube_v3_PlaylistContentDetails"},"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the playlist.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlist\".","default":"youtube#playlist","type":"string"},"localizations":{"description":"Localizations for different languages","type":"object","additionalProperties":{"$ref":"#/components/schemas/youtube_v3_PlaylistLocalization"}},"player":{"$ref":"#/components/schemas/youtube_v3_PlaylistPlayer"},"snippet":{"$ref":"#/components/schemas/youtube_v3_PlaylistSnippet"},"status":{"$ref":"#/components/schemas/youtube_v3_PlaylistStatus"}}},"youtube_v3_PlaylistContentDetails":{"type":"object","properties":{"itemCount":{"description":"The number of videos in the playlist.","format":"uint32","type":"integer"}}},"youtube_v3_PlaylistImage":{"type":"object","properties":{"id":{"description":"Identifies this resource (playlist id and image type).","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistImages\".","default":"youtube#playlistImage","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_PlaylistImageSnippet"}}},"youtube_v3_PlaylistImageListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/youtube_v3_PlaylistImage"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistImageListResponse\".","default":"youtube#playlistImageListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"}}},"youtube_v3_PlaylistImageSnippet":{"description":"A *playlistImage* resource identifies another resource, such as a image, that is associated with a playlist. In addition, the playlistImage resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistImages.list method to retrieve image data for any of those playlists. You can also add or remove images from those lists by calling the playlistImages.insert and playlistImages.delete methods.","type":"object","properties":{"height":{"description":"The image height.","format":"int32","type":"integer"},"playlistId":{"description":"The Playlist ID of the playlist this image is associated with.","type":"string"},"type":{"description":"The image type.","enum":["hero"],"type":"string"},"width":{"description":"The image width.","format":"int32","type":"integer"}}},"youtube_v3_PlaylistItem":{"description":"A *playlistItem* resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.","type":"object","properties":{"contentDetails":{"$ref":"#/components/schemas/youtube_v3_PlaylistItemContentDetails"},"etag":{"description":"Etag of this resource.","type":"string"},"id":{"description":"The ID that YouTube uses to uniquely identify the playlist item.","type":"string"},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistItem\".","default":"youtube#playlistItem","type":"string"},"snippet":{"$ref":"#/components/schemas/youtube_v3_PlaylistItemSnippet"},"status":{"$ref":"#/components/schemas/youtube_v3_PlaylistItemStatus"}}},"youtube_v3_PlaylistItemContentDetails":{"type":"object","properties":{"endAt":{"description":"The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.","type":"string"},"note":{"description":"A user-generated note for this item.","type":"string"},"startAt":{"description":"The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.","type":"string"},"videoId":{"description":"The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.","type":"string"},"videoPublishedAt":{"description":"The date and time that the video was published to YouTube.","format":"date-time","type":"string"}}},"youtube_v3_PlaylistItemListResponse":{"type":"object","properties":{"etag":{"type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of playlist items that match the request criteria.","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_PlaylistItem"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistItemListResponse\".","default":"youtube#playlistItemListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_PlaylistItemSnippet":{"description":"Basic details about a playlist, including title, description and thumbnails. Basic details of a YouTube Playlist item provided by the author. Next ID: 15","type":"object","properties":{"channelId":{"description":"The ID that YouTube uses to uniquely identify the user that added the item to the playlist.","type":"string"},"channelTitle":{"description":"Channel title for the channel that the playlist item belongs to.","type":"string"},"description":{"description":"The item's description.","type":"string"},"playlistId":{"description":"The ID that YouTube uses to uniquely identify thGe playlist that the playlist item is in.","type":"string"},"position":{"description":"The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.","format":"uint32","type":"integer"},"publishedAt":{"description":"The date and time that the item was added to the playlist.","format":"date-time","type":"string"},"resourceId":{"$ref":"#/components/schemas/youtube_v3_ResourceId"},"thumbnails":{"$ref":"#/components/schemas/youtube_v3_ThumbnailDetails"},"title":{"description":"The item's title.","type":"string"},"videoOwnerChannelId":{"description":"Channel id for the channel this video belongs to.","type":"string"},"videoOwnerChannelTitle":{"description":"Channel title for the channel this video belongs to.","type":"string"}}},"youtube_v3_PlaylistItemStatus":{"description":"Information about the playlist item's privacy status.","type":"object","properties":{"privacyStatus":{"description":"This resource's privacy status.","enum":["public","unlisted","private"],"type":"string"}}},"youtube_v3_PlaylistListResponse":{"type":"object","properties":{"etag":{"description":"Etag of this resource.","type":"string"},"eventId":{"description":"Serialized EventId of the request which produced this response.","type":"string"},"items":{"description":"A list of playlists that match the request criteria","type":"array","items":{"$ref":"#/components/schemas/youtube_v3_Playlist"}},"kind":{"description":"Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistListResponse\".","default":"youtube#playlistListResponse","type":"string"},"nextPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.","type":"string"},"pageInfo":{"$ref":"#/components/schemas/youtube_v3_PageInfo"},"prevPageToken":{"description":"The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.","type":"string"},"tokenPagination":{"$ref":"#/components/schemas/youtube_v3_TokenPagination"},"visitorId":{"description":"The visitorId identifies the visitor.","type":"string"}}},"youtube_v3_PlaylistLocalization":{"description":"Playlist localization setting","type":"object","properties":{"description":{"description":"The localized strings for playlist's description.","type":"string"},"title":{"description":"The localized strings for playlist's title.","type":"string"}}},"youtube_v3_PlaylistPlayer":{"type":"object","properties":{"embedHtml":{"description":"An